API Reference

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

NameTypeDescriptionRestrictions
chainIdIDThe unique identifier of a resource (can be a GUID).
endAtstringThe timestamp at which the chain run completed.
envIdIDThe unique identifier of a resource (can be a GUID).
idIDThe unique identifier of a resource (can be a GUID).
launchTypestringThe type of event that triggered the chain run.
pausedAtstringThe timestamp at which the chain run was paused.
resultTextstringThe result of the chain run.
resumedAtstringThe timestamp at which the chain run was resumed.
startAtstringThe timestamp at which the chain run started.
statestringThe state of the chain run.
userIdIDThe unique identifier of a resource (can be a GUID).
userNamestringThe user that triggered the chain run.

Enumerated Values

PropertyValue
launchTypemanual
launchTypeapi
launchTypeschedule
launchTypetrigger
launchTypeslack
launchTypetrigger_event
statesleeping
stateenqueueing
statepaused
stateerrored
statewarned
stateall_succeeded
statestopped

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

NameTypeDescriptionRestrictions
chainExecutors[ChainRun]An array of the chain runs.
cursorstringCursor 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

NameTypeDescriptionRestrictions
dataChainRunPage

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

Properties

NameTypeDescriptionRestrictions
ChainRun
object
anonymous.nodes[ChainRunNode]

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",
  "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"
    }
  ]
}

ChainRunNode

Properties

NameTypeDescriptionRestrictions
endAtstring
idIDThe unique identifier of a resource (can be a GUID).
iterableboolean
namestring
nodeIdIDThe unique identifier of a resource (can be a GUID).
nodeTypestring
results[ChainRunNodeResult]
startAtstring
statestring

Enumerated Values

PropertyValue
nodeTypecommand
nodeTypeevent
statesleeping
statepaused
stateskipped
stateerrored
statewarned
statesucceeded

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"
}