Piece

PreviousJob NextPreparation

Last updated 1 year ago

Was this helpful?

Get metadata for a piece

Get metadata for a piece for how it may be reassembled from the data source

get

/piece/{id}/metadata

Path parameters

idstringrequired

Piece CID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//localhost:9090/api/piece/{id}/metadata'

200

400

404

500

{}

List all prepared pieces for a preparation

get

/preparation/{id}/piece

Path parameters

idstringrequired

Preparation ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//localhost:9090/api/preparation/{id}/piece'

200

400

500

[
  {
    "attachmentId": 1,
    "source": {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": [
            "[Circular Reference]"
          ],
          "sourceStorages": [
            "[Circular Reference]"
          ]
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": [
            "[Circular Reference]"
          ],
          "sourceStorages": [
            "[Circular Reference]"
          ]
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "storageId": 1,
    "pieces": [
      {
        "attachmentId": 1,
        "createdAt": "text",
        "fileSize": 1,
        "id": 1,
        "jobId": 1,
        "numOfFiles": 1,
        "pieceCid": "text",
        "pieceSize": 1,
        "preparationId": 1,
        "rootCid": "text",
        "storageId": 1,
        "storagePath": "text"
      }
    ]
  }
]

Add a piece to a preparation

post

/preparation/{id}/piece

Path parameters

idstringrequired

Preparation ID or name

Body

fileSizeinteger

File size of the CAR file, this is required for boost online deal

pieceCidstringrequired

CID of the piece

pieceSizestringrequired

Size of the piece

rootCidstring

Root CID of the CAR file, used to populate the label field of storage deal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/piece' \
  --header 'Content-Type: application/json' \
  --data '{"pieceCid":"text","pieceSize":"text"}'

200

400

500

{
  "attachmentId": 1,
  "createdAt": "text",
  "fileSize": 1,
  "id": 1,
  "jobId": 1,
  "numOfFiles": 1,
  "pieceCid": "text",
  "pieceSize": 1,
  "preparationId": 1,
  "rootCid": "text",
  "storageId": 1,
  "storagePath": "text"
}