Fetch a previously submitted task
GET/tasks/:jobid
Fetch a document and associated processing task by task id.
This task is linked to a single document. If the task is DELETED
, all associated links will lead to non-existent URLs, as the corresponding document has been removed from our system.
Request
Path Parameters
Id of the task to retrieve.
Header Parameters
Request signature (see the authentication section).
Responses
- 200
- 400
- 403
- 404
- 500
Successful query.
- application/json
- Schema
- Example (from schema)
Schema
File name as submitted
ID of the task
Time of creation (seconds since epoch)
Your client name
Your organisation name
Possible values: Value must match regular expression ^https://
URL to download model (if requested with includePresigned)
Path of the output model file in S3 (see modelUrl
for a presigned URL)
Path of the original uploaded file in S3
Suggested file name for the output model: clientFilename, but with extension changed to .json
Possible values: [PENDING_UPLOAD
, PROCESSING
, DELETED
, SUCCESS
]
Task status
{
"clientFilename": "string",
"jobid": "string",
"submitted": 0,
"companyName": "string",
"client": "string",
"modelUrl": "string",
"modelFilename": "string",
"originalFilename": "string",
"clientModelFilename": "string",
"status": "PENDING_UPLOAD"
}
Bad request. It is likely that some parameters are missing, or are of the wrong type.
Unauthorised. You credentials are valid, but you are not allowed to perform this operation.
Not found. The resource (e.g. task) does not exist.
Server-side error. Please retry later or contact us for more information.