Sign in

v1

latestOpenAPI 3.0.12026-07-1431191129.7 KB
Pipeline Executions

Get a pipeline execution

Get a pipeline execution.

get/sources/{sourceKey}/v1/pipelines/executions/{pipelineExecutionId}

Path parameters

sourceKeystring required

The key of the source.

pipelineExecutionIdstring required

The id of the pipeline execution.

Query parameters

withOperationBodyboolean

If set to true, the response will include the body of the operation that triggered the pipeline execution and the operation processed by the pipeline. Defaults to false.

Response

Returns the pipeline execution.

idstring required

id to refer for a specific pipeline execution.

pipelineDefinitionIdstring required

The id with version in the format <id>.<version>.

status'SUCCESSFUL' | 'ERROR' | 'IN_PROGRESS' | 'IN_REVIEW' | 'CANCELLED' | 'DROPPED' required

Status of the pipeline execution.

  • SUCCESSFUL: The pipeline execution completed successfully. Every step of the pipeline was executed successfully and the change has been accepted in the system.
  • ERROR: The pipeline execution failed at a step due to a system error.
  • IN_PROGRESS: The pipeline execution is being processed by the system.
  • IN_REVIEW: The pipeline execution is waiting for a manual action. Refer to the ActOnPipelineExecution endpoint.
  • CANCELLED: The pipeline execution has been short-circuited by the system and never completed.
  • DROPPED: The pipeline execution has been dropped because the change has been rejected by the user following review.
createdAtstring date-time required
updatedAtstring date-time required