Executions

List all Executions

Lists execution

Lists executions matching the optional filter

GET/v1alpha1/executions

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

executionarray of v1alpha1Execution (object)

execution is the execution details.

statusTableobject

status_table is a table containing information about the total number of executions in the list and their status.

nextPageTokenstring

next_page_token represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request.

pageCountinteger (int32)

page_count is the number of pages.

aggregateTotalTableobject

status_total_table is a table containing information about the total number of executions in the list and their status.

Request

JavaScriptCurl

const response = await fetch('/v1alpha1/executions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": [
    {
      "id": "text",
      "workflowName": "text",
      "createTime": "2024-04-27T15:54:21.789Z",
      "startTime": "2024-04-27T15:54:21.789Z",
      "endTime": "2024-04-27T15:54:21.789Z",
      "duration": "text",
      "version": "text",
      "executionStatus": "EXECUTION_STATUS_UNSPECIFIED",
      "inputs": "text",
      "output": "Ynl0ZXM=",
      "executor": "text",
      "approver": "text",
      "reason": "text",
      "executionType": "EXECUTION_TYPE_UNSPECIFIED"
    }
  ],
  "nextPageToken": "text"
}

Curl Example:

curl 'https://<domain>/v1alpha1/executions?pageSize=10' -H "X-unSkript-API-Key:<api token>"

Get Details of a Specific Execution

Get execution details

Gets execution details

GET/v1alpha1/executions/{executionId}

Path parameters

executionId*string

execution_id is the id of execution.

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

executionv1alpha1Execution (object)

Execution is the execution details.

Request

JavaScriptCurl

const response = await fetch('/v1alpha1/executions/{executionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": {
    "id": "text",
    "workflowName": "text",
    "createTime": "2024-04-27T15:54:21.789Z",
    "startTime": "2024-04-27T15:54:21.789Z",
    "endTime": "2024-04-27T15:54:21.789Z",
    "duration": "text",
    "version": "text",
    "executionStatus": "EXECUTION_STATUS_UNSPECIFIED",
    "inputs": "text",
    "output": "Ynl0ZXM=",
    "executor": "text",
    "approver": "text",
    "reason": "text",
    "executionType": "EXECUTION_TYPE_UNSPECIFIED"
  }
}

Curl Example:

curl  'https://<domain>/v1alpha1/executions/10007011-12a6-41c1-98ea-1b3ced62604e' \
      -H "X-unSkript-API-Key:<api token>"