Batch task status

Gets batch task status.

Batch task status is available 24 hours from posting the batch.

URI

GET: /v1/batch/:batchId/:taskId

Success response

Successful task status request will return 200 (OK) and JSON.

Response JSON

completed: true if task is completed.

errors: true if task produced errors.

statusMessage: textual presentation of current task status: “Queued”, “Running”, “Ready”, error message.

startDateTime: date and time when task processing started, i.e. when template compose started.

endDateTime: date and time when task processing finished, i.e. when template compose finished.

logs: task compose log entries (SEVERE messages).

results: array containing all resultID values of files created by store command during compose.

resultList: array containing result objects with “id” and “url” properties. URL can be used to fetch the result created by store command.

Example

CODE

GET: https://dynamo-api.documill.com/v1/batch/3674273467/42873894234

{
    "startDateTime": "2022-02-10T11:03:36.498963Z",
    "log": [],
    "completed": true,
    "endDateTime": "2022-02-10T11:03:39.616069Z",
    "results": [
        "Profile"
    ],
    "resultList: [
        {
           "id": "Profile",
           "url": <url>
        }
    ],
    "errors": false,
    "statusMessage": "Completed"
}