The tasks API allows customers using Constructor's ingestion service to request the status of asynchronous jobs, such as catalog uploads and user data requests made for compliance reasons.
The tasks endpoint is most commonly used to verify on the status of files uploaded for ingestion to the FTP and catalog HTTP endpoints, to request ingestion jobs in progress, queued, succeeded and failed.
Additionally, if the task is an ingestion task and the status of the task is DONE
, a result
field is added to the response that contains the changes the task made, and a boolean value that indicates if the changes have been indexed. If such task is in status FAILED
, instead of result
the response will have an error
field with failure details.