curl --request PUT \
--url https://platform.kodexa.ai/api/executions/{id}/cancel \
--header 'x-api-key: <api-key>'{
"assistantId": "<string>",
"changeSequence": 123,
"context": {},
"createdOn": "2023-11-07T05:31:56Z",
"deleteLoggingOnSuccess": true,
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"loggingEnabled": true,
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"status": "<string>",
"statusMessage": "<string>",
"stepType": "<string>"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"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>"
}Cancels a running execution. The execution will be marked as cancelled and processing will stop.
curl --request PUT \
--url https://platform.kodexa.ai/api/executions/{id}/cancel \
--header 'x-api-key: <api-key>'{
"assistantId": "<string>",
"changeSequence": 123,
"context": {},
"createdOn": "2023-11-07T05:31:56Z",
"deleteLoggingOnSuccess": true,
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"loggingEnabled": true,
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": {},
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
{}
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"status": "<string>",
"statusMessage": "<string>",
"stepType": "<string>"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"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>"
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Unique identifier (UUID) of the execution.
Execution cancelled
An execution records the details and results of a processing session.
Optimistic locking version number.
Show child attributes
Timestamp when the execution was created.
Show child attributes
Unique identifier (UUID) for the execution.
Show child attributes
Show child attributes
Show child attributes
Timestamp when the execution was last updated.
Secondary UUID identifier.