startPipeline

See also: Actions

Description

Start a pipeline run. Field parameters can be used to provide variable settings for a custom pipeline run. Use the wait parameter to wait for the pipeline to be COMPLETED (or other state provided by the state parameter) before the action completes. When waiting for a COMPLETED pipeline, the action will fail if the pipeline result is not successful unless the continue parameter is specified. Alternatively, the same wait related parameters can a used on a separate getPipeline action enabling multiple pipelines to be started in a script without wait and then followed later by getPipeline with wait to handle results.

Required Parameters

repository, pipeline

Optional Parameters

workspace, branch, commit, selector, selectorType, wait, state, timeout, continue, field

Type

Start

Category

Pipelines

Output Formats

Replacement Variables

pipeline, pipelineResult, pipelineState, pipelineUuid, repository, repositoryName, repositoryUuid, workspace, workspaceName, workspaceUuid

Since Version10.0

Examples

startPipeline

Related How To's