restartPipelineRun

Back to index

Summary

Restart a pipeline run.

request

Stringrequired

This parameter and the value displayed are required; request=restartPipelineRun must appear in your query string.

flowRuntimeId

Stringoptional

The ID of the flow runtime.

actualParameters

Stringoptional

The list of actual parameters.

comment

Stringoptional

Comment provided while restarting pipeline run which has completed with error.

flowRuntimeName

Stringoptional

The name of the flow runtime.

gateType

Stringoptional

The type of the gate.

Possible values: "POST", "PRE"

projectName

Stringoptional

The name of the project.

stageName

Stringoptional

The name of a stage from which to restart a pipeline.

taskName

Stringoptional

The name of a high-level task in the last active stage from which to restart a pipeline.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.restartPipelineRun(
  request: "test-request"
  /* optional arguments */
)▼