Tasks

Update tasks

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

Update the status of a list of tasks to queue or cancel them.

patch/v1/tasks

Request

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

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

Example request

{
  "tasks": [
    {
      "id": 1,
      "status": "QUEUED"
    }
  ]
}

Response

OK

Example response

{
  "tasks": [
    {
      "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.