workflows

Get a workflow execution

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/workflows/executions/{executionId}</span></div>

Refer to Spaces for more information.

Retrieve details of a single workflow execution by its ID.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:read AND workflowsManagement:readExecution. Extended privileges (optional, expand functionality when granted): workflowsManagement:managed:readExecution.

get/api/workflows/executions/{executionId}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/workflows/executions/{executionId}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

executionIdstring required

Workflow execution ID

Query parameters

includeInputboolean

Include execution input data.

includeOutputboolean

Include execution output data.

omitStepExecutionsboolean

When true, omit the embedded stepExecutions array. Defaults to false. When this is false, the embed is capped at 5000 steps.

Response

Indicates a successful response

Changes

  • eaa1b5e3c054Revision changes
    • warning

      for the path request parameter executionId, the maxLength was set to 255

    • info

      added the new optional query request parameter omitStepExecutions