Job

PreviousFile NextPiece

Last updated 1 year ago

Was this helpful?

Pack a pack job into car files

post

/job/{id}/pack

Path parameters

idintegerrequired

Pack job ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/job/{id}/pack'

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"
}

prepare to pack a data source

post

/preparation/{id}/source/{name}/finalize

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/finalize'

204

400

500

No body

No Content

Pause an ongoing DAG generation job

post

/preparation/{id}/source/{name}/pause-daggen

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/pause-daggen'

200

400

500

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Pause a specific packing job

post

/preparation/{id}/source/{name}/pause-pack/{job_id}

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

job_idintegerrequired

Pack Job ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/pause-pack/{job_id}'

200

400

500

[
  {
    "attachmentId": 1,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 1,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Pause an ongoing scanning job

post

/preparation/{id}/source/{name}/pause-scan

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/pause-scan'

200

400

500

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start a new DAG generation job

post

/preparation/{id}/source/{name}/start-daggen

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/start-daggen'

200

400

500

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start or restart a specific packing job

post

/preparation/{id}/source/{name}/start-pack/{job_id}

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

job_idintegerrequired

Pack Job ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/start-pack/{job_id}'

200

400

500

[
  {
    "attachmentId": 1,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 1,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Start a new scanning job

post

/preparation/{id}/source/{name}/start-scan

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Storage ID or name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/start-scan'

200

400

500

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}