文件

Previous交易 Next作业

Last updated 1 year ago

Was this helpful?

Get details about a file

get

Path parameters

idanyrequired

File ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:9090/api/file/{id}'

200

500

{
  "attachmentId": 1,
  "cid": "text",
  "directoryId": 1,
  "fileRanges": [
    {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  ],
  "hash": "text",
  "id": 1,
  "lastModifiedNano": 1,
  "path": "text",
  "size": 1
}

Get all deals that have been made for a file

get

Path parameters

idanyrequired

File ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:9090/api/file/{id}/deals'

200

500

[
  {
    "deals": [
      {
        "clientId": "text",
        "createdAt": "text",
        "dealId": 1,
        "endEpoch": 1,
        "errorMessage": "text",
        "id": 1,
        "label": "text",
        "lastVerifiedAt": "text",
        "pieceCid": "text",
        "pieceSize": 1,
        "price": "text",
        "proposalId": "text",
        "provider": "text",
        "scheduleId": 1,
        "sectorStartEpoch": 1,
        "startEpoch": 1,
        "state": "proposed",
        "updatedAt": "text",
        "verified": true
      }
    ],
    "fileRange": {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  }
]

prepare job for a given item

post

Path parameters

idanyrequired

File ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:9090/api/file/{id}/prepare_to_pack'

200

400

500

Push a file to be queued

post

Tells Singularity that something is ready to be grabbed for data preparation

Path parameters

idanyrequired

Preparation ID or name

nameanyrequired

Source storage ID or name

Body

pathstring

Path to the new file, relative to the source

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:9090/api/preparation/{id}/source/{name}/file' \
  --header 'Content-Type: application/json' \
  --data '{
    "path": "text"
  }'

200

400

500

{
  "attachmentId": 1,
  "cid": "text",
  "directoryId": 1,
  "fileRanges": [
    {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  ],
  "hash": "text",
  "id": 1,
  "lastModifiedNano": 1,
  "path": "text",
  "size": 1
}