Sign in

v1

latestOpenAPI 3.0.12026-07-265879107.5 KB
Executions

Get a playbook execution by its ID

Retrieve a single playbook execution by its id.

get/workspace/{ws_id}/executions/{id}

Path parameters

ws_idstring required

The ID of the workspace containing the execution

idstring required

The ID of the playbook execution to retrieve

Query parameters

withApplyViewboolean

When set to true, retrieve enhanced data

Response

Execution with subflow name mapping

app_idstring
async_parent_execution_idstring
cancel_reasonstring
created_atinteger
created_bystring
ctrl_idstring
display_namestring

The execution's display name

draft_execution_numberinteger
durationinteger

The runtime duration in milliseconds

engine_v2_compile_errorstring
engine_versionstring

The preferred workflow engine version

error_detailsobject
eventobject

The execution's trigger event payload

execution_depthinteger
execution_numberinteger

UNIQUE INDEX idx_playbook_executions_pbid_en

finished_atinteger
idstring
input_values_origin_exec_idstring
inputsActionInputsInputParams
last_playbook_namestring

LastPlaybookName Holds last playbook name after playbook deletion to be used in display names for past executions

namestring
net_runtime_msinteger
pack_idstring

The parent automation pack id

parent_execution_idstring
playbookstring
playbook_deletedboolean

Whether the playbook was deleted

playbook_idstring

UNIQUE INDEX idx_playbook_executions_pbid_en

playbook_namestring

The playbook name

runner_cluster_versionstring
runner_group_idstring
runner_idstring

use text column type to allow empty strings

runner_versionstring
scheduled_trigger_timezonestring

Timezone for scheduled trigger

started_atinteger
statestring
state_uistring
step_resultsModelsStepResults
subflows_reference_to_name_mappingobject

Subflow references to playbook names mapping

tenant_idstring
test_session_idstring
timeoutinteger

timeout in milliseconds

top_execution_idstring
top_execution_started_atinteger
trigger_typestring

The type of the trigger of the workflow

typestring
updated_atinteger
updated_bystring
versionstring
with_concurrency_limitboolean
workspace_idstring

Example response

{
  "display_name": "Restart pod #12",
  "duration": 1523,
  "pack_id": "pack_01HZZ",
  "playbook_name": "Restart pod",
  "scheduled_trigger_timezone": "America/New_York",
  "subflows_reference_to_name_mapping": {
    "subflow_ref_1": "Child flow"
  }
}