Skip to main content
GET
/
api
/
executions
List Executions
curl --request GET \
  --url https://platform.kodexa.ai/api/executions \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "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>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of Execution

Paginated response containing Execution items.

​
content
object[]

Array of Execution items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.