abortPipelineRun
completeManualTask
Complete manual task operation.
Arguments
Argument Name | Type | Description |
---|---|---|
flowRuntimeId | String | The id of the flow runtime (Required) |
stageName | String | The name of the stage (Required) |
taskName | String | The name of the task (Required) |
action | String | The type of action to be taken on the manual process step or manual task or gate task |
actualParameters | ActualParameter array | Actual parameters passed to an invoked subprocedure |
evidence | String | Evidence provided while taking an action on the manual process step or manual task or gate task |
gateType | String | The type of the gate. |
completeRuntimeWaitDependency
Complete a wait dependency for a stage or task
Arguments
Argument Name | Type | Description |
---|---|---|
flowRuntimeId | String | The UUID of the invoking flowRuntime. |
projectName | String | The name for the project that contains the wait dependency. |
pipelineName | String | The name of the pipeline |
stageName | String | The name of the stage |
runtimeWaitDependencyName | String | The name of the runtimeWaitDependency. |
dependentFlowRuntimeId | String | The UUID of the dependent flowRuntime. |
dependentGateType | String | The type of dependent gate. |
dependentPipelineName | String | The name of the dependent pipeline |
dependentProjectName | String | The name of the dependent project |
dependentReleaseName | String | The name of the dependent release |
dependentStageName | String | The name of the dependent stage |
dependentTaskName | String | The name of the dependent task |
gateType | String | The type of gate. |
releaseName | String | The name of the release |
taskName | String | The name of the task |
deletePipelineRun
getPipelineRunAuditReport
getPipelineRuntimeDetails
getPipelineRuntimes
Return pipeline runs.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name of the project |
releaseName | String | The name of the release |
filters | Filter array | Filters |
firstResult | Integer | Result pagination: the first row to return. |
flowRuntimeId | String | The id of the flow runtime |
flowRuntimeName | String | The name of the flow runtime |
maxResults | Integer | Result pagination: the number of rows to return. |
pipelineName | String | The name of the pipeline |
releaseId | String | The id of the release |
sortKey | String | How to sort the results. |
sortOrder | String | Which order to sort in |
viewName | String | The name of the view. |
getReleaseTimelineDetails
getRunHierarchy
Get pipeline or release run hierarchy
Arguments
Argument Name | Type | Description |
---|---|---|
flowRuntimeId | String | The id of the flow runtime |
filters | Filter array | Filters |
mode | String | The mode of portfolio view |
pipelineName | String | The name of the pipeline |
projectName | String | The name of the project |
releaseName | String | The name of the release |
getRuntimeWaitDependencies
restartPipelineRun
Restart a pipeline run.
Arguments
Argument Name | Type | Description |
---|---|---|
flowRuntimeId | String | The id of the flow runtime |
actualParameters | ActualParameter array | The list of actual parameters. |
comment | String | Comment provided while restarting pipeline run which has completed with error. |
flowRuntimeName | String | The name of the flow runtime |
gateType | String | The type of the gate. |
projectName | String | The name of the project |
stageName | String | The name of a stage from which to restart a pipeline. |
taskName | String | The name of a high-level task in the last active stage from which to restart a pipeline. |
retryTask
Continue to run pipeline flow runtime if it there are tasks waiting on error.
Arguments
Argument Name | Type | Description |
---|---|---|
flowRuntimeId | String | The id of the flow runtime (Required) |
stageName | String | The name of the stage (Required) |
taskName | String | The name of the task (Required) |
action | String | Action to execute: rerun (default), skip or fail the task |
comment | String | Comment provided while retry an action on the manual process step or manual task or gate task |
gateType | String | The type of the gate. |
subapplication | String | The name of the sub application. |
subproject | String | The name of the project that contains the sub application |
subservice | String | The name of the sub service. |
runFutureTask
run a task out of order - in a stage or gate that hasn’t started yet.
runPipeline
Run the specified pipeline, return the flowRuntimeId.
Arguments
Argument Name | Type | Description |
---|---|---|
pipelineName | String | The name of the pipeline (Required) |
projectName | String | The name for the project that must be unique among all projects. (Required) |
actualParameters | ActualParameter array | The list of actual parameters. |
credentialReferenceParameters | array | List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime. |
credentials | Credential array | Credentials to be used in the state. |
parsedWebhookData | String | JSON with parsed webhook data to be set on a pipeline/release/procedure run. |
priority | String | The priority of jobs launched by the pipeline. |
releaseName | String | The name of the release |
scheduleName | String | Name for the schedule; must be unique among all schedules for the project. |
stagesToRun | String array | One or more stages to run in a pipeline. |
startingStage | String | The name of the starting stage. |
webhookData | String | The webhook data to be set on the pipeline/release/procedure run. |
webhookHeaders | String | The webhook headers in JSON format to be set on the pipeline/release/procedure run. |