execution

The Execution API endpoints provide an interface for getting information about a chain’s execution, such as when it starts and stops, its status, and run history.

ChainRun

Properties

Name	Type	Description	Restrictions
chainId	ID	The unique identifier of a resource (can be a GUID).
endAt	string	The timestamp at which the chain run completed.
envId	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
launchType	string	The type of event that triggered the chain run.
pausedAt	string	The timestamp at which the chain run was paused.
resultText	string	The result of the chain run.
resumedAt	string	The timestamp at which the chain run was resumed.
startAt	string	The timestamp at which the chain run started.
state	string	The state of the chain run.
userId	ID	The unique identifier of a resource (can be a GUID).
userName	string	The user that triggered the chain run.

Enumerated Values

Property	Value
launchType	manual
launchType	api
launchType	schedule
launchType	trigger
launchType	slack
launchType	trigger_event
state	sleeping
state	enqueueing
state	paused
state	errored
state	warned
state	all_succeeded
state	stopped

Example

{
  "chainId": "74",
  "endAt": "string",
  "envId": "74",
  "id": "74",
  "launchType": "manual",
  "pausedAt": "string",
  "resultText": "string",
  "resumedAt": "string",
  "startAt": "string",
  "state": "sleeping",
  "userId": "74",
  "userName": "string"
}

ChainRunPage

Properties

Name	Type	Description	Restrictions
chainExecutors	[ChainRun]	An array of the chain runs.
cursor	string	Cursor value indicating page information for the data to retrieve.

Example

{
  "chainExecutors": [
    {
      "chainId": "74",
      "endAt": "string",
      "envId": "74",
      "id": "74",
      "launchType": "manual",
      "pausedAt": "string",
      "resultText": "string",
      "resumedAt": "string",
      "startAt": "string",
      "state": "sleeping",
      "userId": "74",
      "userName": "string"
    }
  ],
  "cursor": "string"
}

ChainRunPageResponse

Properties

Name	Type	Description	Restrictions
data	ChainRunPage

Example

{
  "data": {
    "chainExecutors": [
      {
        "chainId": "74",
        "endAt": "string",
        "envId": "74",
        "id": "74",
        "launchType": "manual",
        "pausedAt": "string",
        "resultText": "string",
        "resumedAt": "string",
        "startAt": "string",
        "state": "sleeping",
        "userId": "74",
        "userName": "string"
      }
    ],
    "cursor": "string"
  }
}

ChainRunWithNodes

A chain run object with details about all of the command nodes used in that run.

Properties

Name	Type	Description	Restrictions
chainId	ID	The unique identifier of a resource (can be a GUID).
endAt	string	The timestamp at which the chain run completed.
envId	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
launchType	string	The type of event that triggered the chain run.
nodes	[ChainRunNode]
pausedAt	string	The timestamp at which the chain run was paused.
resultText	string	The result of the chain run.
resumedAt	string	The timestamp at which the chain run was resumed.
startAt	string	The timestamp at which the chain run started.
state	string	The state of the chain run.
userId	ID	The unique identifier of a resource (can be a GUID).
userName	string	The user that triggered the chain run.

Enumerated Values

Property	Value
launchType	manual
launchType	api
launchType	schedule
launchType	trigger
launchType	slack
launchType	trigger_event
state	sleeping
state	enqueueing
state	paused
state	errored
state	warned
state	all_succeeded
state	stopped

Example

{
  "chainId": "74",
  "endAt": "string",
  "envId": "74",
  "id": "74",
  "launchType": "manual",
  "nodes": [
    {
      "endAt": "string",
      "id": "74",
      "iterable": true,
      "name": "string",
      "nodeId": "74",
      "nodeType": "command",
      "results": [
        {
          "id": "74",
          "iteratorValue": "string",
          "outputLogUrl": "string",
          "outputVariables": {
            "data": "string",
            "path": "string"
          },
          "state": "active"
        }
      ],
      "startAt": "string",
      "state": "sleeping"
    }
  ],
  "pausedAt": "string",
  "resultText": "string",
  "resumedAt": "string",
  "startAt": "string",
  "state": "sleeping",
  "userId": "74",
  "userName": "string"
}

ChainRunNode

Properties

Name	Type	Description	Restrictions
endAt	string
id	ID	The unique identifier of a resource (can be a GUID).
iterable	boolean
name	string
nodeId	ID	The unique identifier of a resource (can be a GUID).
nodeType	string
results	[ChainRunNodeResult]
startAt	string
state	string

Enumerated Values

Property	Value
nodeType	command
nodeType	event
state	sleeping
state	paused
state	skipped
state	errored
state	warned
state	succeeded

Example

{
  "endAt": "string",
  "id": "74",
  "iterable": true,
  "name": "string",
  "nodeId": "74",
  "nodeType": "command",
  "results": [
    {
      "id": "74",
      "iteratorValue": "string",
      "outputLogUrl": "string",
      "outputVariables": {
        "data": "string",
        "path": "string"
      },
      "state": "active"
    }
  ],
  "startAt": "string",
  "state": "sleeping"
}