Read the status of a background task.

Returns the task's status, the number of items it has processed so far in count, and errorMessage when it
ended in an error. status is WAITING before the task starts and EXECUTING while it runs - both mean the
work is not finished yet - then COMPLETED on success or ERROR on failure; TO_CANCEL, CANCELLED and
EXPIRED mean the task will not finish its work. Poll until the status is no longer WAITING or EXECUTING.

Use it for every operation that answers with a task ID instead of doing the work in the request: archiving
products in bulk, deleting a catalog node with its subtree, and the Category Level Attribute (CLA) operations
under /catalogs/nodes/{id}/attributes, which propagate values onto products in the background. Those
operations return the ID in the Resource-Id response header and point Location at this path. Fails when no
task with that ID exists.

For more detailed information on how to work with product bulk actions in Bluestone PIM, refer to our help pages
Use product bulk actions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the task, as returned in the Resource-Id response header of the operation that
scheduled it.

Example: 634c26e14cedfd0001775e9f

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json