COconstructor
Tasks

Update task

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(w).

Update the status of a single task to queue or cancel it.

patch/v1/tasks/{task_id}

Request

  • Base URL
    https://ac.cnstrc.com
  • URL
    https://ac.cnstrc.com/v1/tasks/{task_id}
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

task_idinteger required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

status'QUEUED' | 'CANCELED' required

This contains the new status that you want to update the task with. It is only allowed to cancel queued tasks by setting their status to CANCELED or re-run tasks that are not in progress by setting their status to QUEUED.In-progress tasks cannot be modified.

Example request

{
  "status": "QUEUED"
}

Response

OK

OR
OR
OR
OR
OR

Example response

{
  "result": {
    "index_built": true,
    "ingestion_warnings": [
      {
        "code": "MISSING_FIELD",
        "message": "Field 'price' is missing for item 'product-123'",
        "data": {
          "item_id": "product-123",
          "field": "price"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.