Cancel execution

Cancels a running execution. The execution will be marked as cancelled and processing will stop.

PUT /api/executions/{id}/cancel

Cancel execution

cURL

curl --request PUT \
  --url https://platform.kodexa.ai/api/executions/{id}/cancel \
  --header 'x-api-key: <api-key>'

200

{
  "assistantId": "<string>",
  "changeSequence": 123,
  "context": {},
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "documentFamilyId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "exceptionDetails": {
    "advice": "<string>",
    "cause": "<unknown>",
    "description": "<string>",
    "documentationUrl": "<string>",
    "errorMessage": "<string>",
    "errorType": "<string>",
    "executedVersion": "<string>",
    "help": "<string>",
    "message": "<string>",
    "optionErrors": {},
    "stackTrace": [
      "<unknown>"
    ],
    "statusCode": 123,
    "validationErrors": [
      {
        "description": "<string>",
        "message": "<string>",
        "option": "<string>"
      }
    ]
  },
  "id": "<string>",
  "idempotencyKey": "<string>",
  "organizationId": "<string>",
  "parentExecutionId": "<string>",
  "pipeline": {
    "exceptions": [
      {
        "advice": "<string>",
        "cause": "<unknown>",
        "description": "<string>",
        "documentationUrl": "<string>",
        "errorMessage": "<string>",
        "errorType": "<string>",
        "executedVersion": "<string>",
        "help": "<string>",
        "message": "<string>",
        "optionErrors": {},
        "stackTrace": [
          "<unknown>"
        ],
        "statusCode": 123,
        "validationErrors": [
          {
            "description": "<string>",
            "message": "<string>",
            "option": "<string>"
          }
        ]
      }
    ],
    "id": "<string>",
    "ref": "<string>",
    "steps": [
      {
        "conditional": "<string>",
        "context": {},
        "end": "<string>",
        "exceptionDetails": {
          "advice": "<string>",
          "cause": "<unknown>",
          "description": "<string>",
          "documentationUrl": "<string>",
          "errorMessage": "<string>",
          "errorType": "<string>",
          "executedVersion": "<string>",
          "help": "<string>",
          "message": "<string>",
          "optionErrors": {},
          "stackTrace": [
            "<unknown>"
          ],
          "statusCode": 123,
          "validationErrors": [
            {
              "description": "<string>",
              "message": "<string>",
              "option": "<string>"
            }
          ]
        },
        "executionPolicy": {
          "backoffBaseSeconds": 123,
          "backoffStrategy": "<string>",
          "maxAttempts": 123,
          "onExhausted": "<string>",
          "timeoutSeconds": 123
        },
        "extensionPackRef": "<string>",
        "id": "<string>",
        "inputId": "<string>",
        "name": "<string>",
        "optionTypes": {},
        "options": {},
        "outputId": "<string>",
        "outputIds": "<string>",
        "processingTime": 123,
        "progress": 123,
        "progressMax": 123,
        "ref": "<string>",
        "start": "<string>",
        "statusMessage": "<string>"
      }
    ],
    "valid": true
  },
  "priority": 123,
  "processingTime": 123,
  "sessionId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "statusDetails": {
    "detail": "<string>",
    "message": "<string>",
    "progress": 123,
    "progressMax": 123,
    "stepStatus": "<string>"
  },
  "targets": {
    "instances": [
      {
        "contentObjectId": "<string>",
        "documentFamilyId": "<string>",
        "labelsToApply": [
          "<string>"
        ],
        "ref": "<string>",
        "taxonomyRefs": [
          "<string>"
        ],
        "type": "<string>"
      }
    ]
  },
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the execution.

Response

200

application/json

Execution cancelled

An execution records the details and results of a processing session.

assistantId · string | null

changeSequence · integer<int32>

Optimistic locking version number.

context · object

Show child attributes

createdOn · string<date-time>

Timestamp when the execution was created.

description · string

documentFamilyId · string | null

endDate · string<date-time> | null

exceptionDetails · object

Show child attributes

id · string

Unique identifier (UUID) for the execution.

idempotencyKey · string | null

organizationId · string

parentExecutionId · string | null

pipeline · object

Show child attributes

priority · integer<int32>

processingTime · integer<int64>

sessionId · string | null

startDate · string<date-time> | null

status · enum<string>

Available options: PENDING, RUNNING, SUCCEEDED, FAILED, REQUESTED, SKIPPED, CANCELLING, CANCELLED, PENDING_REPROCESSING, REPROCESSED

statusDetails · object

Show child attributes

targets · object

Show child attributes

updatedOn · string<date-time>

Timestamp when the execution was last updated.

uuid · string

Secondary UUID identifier.