Skip to main content
GET
/
api
/
recent-executions
/
{id}
Get RecentExecution by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/recent-executions/{id} \
  --header 'x-api-key: <api-key>'
{
  "assistant": {
    "active": true,
    "assistantDefinitionId": "<string>",
    "assistantRole": "<string>",
    "changeSequence": 123,
    "chatEnabled": true,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteLoggingOnSuccess": true,
    "deleted": true,
    "description": "<string>",
    "id": "<string>",
    "loggingEnabled": true,
    "name": "<string>",
    "options": {},
    "priorityHint": 123,
    "project": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "<string>",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "<string>",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "<string>",
      "id": "<string>",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "<string>",
      "notes": "<string>",
      "options": {
        "dataOptions": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "dataProperties": {},
        "groupTaxonTypeFeatures": {},
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {},
        "taskOptions": {
          "showNewTask": true,
          "showTakeNext": true
        },
        "taxonTypeFeatures": {}
      },
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "<string>",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "<string>",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "<string>",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "<string>",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "image": "<string>",
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "roles": {
          "roles": [
            "<string>"
          ]
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "showDeveloperTools": true,
        "title": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "<string>"
      },
      "ownerId": "<string>",
      "projectTemplateRef": "<string>",
      "searchText": "<string>",
      "slug": "<string>",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "<string>",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "<string>",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "<string>",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "<string>",
          "organizationStatus": "<string>",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "<string>",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "organizationId": "<string>",
        "production": true,
        "status": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "statusId": "<string>",
      "statusType": "<string>",
      "templateArticleId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "projectId": "<string>",
    "runOnExistingContent": true,
    "showInTraining": true,
    "slug": "<string>",
    "subscription": "<string>",
    "testOptions": {},
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "validationErrors": {
      "instances": [
        {
          "description": "<string>",
          "message": "<string>",
          "option": "<string>"
        }
      ]
    }
  },
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "execution": {
    "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>"
  },
  "id": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

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 resource.

Response

The RecentExecution

A recent execution records a document processing execution for quick access.

assistant
object
changeSequence
integer<int32>
createdOn
string<date-time>
execution
object
id
string
updatedOn
string<date-time>
uuid
string