startRelease

Summary

Starts a release. If the release pipeline configures disableMultipleActiveRuns= true, only one active run of this release pipeline is allowed at a time and attempts to start more than one results in an exception.

projectName

Stringrequired

The name for the project that must be unique among all projects.

releaseName

Stringrequired

The name of the release.

credentialReferenceParameters

Array<CredentialReferenceParameter>optional

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

Array<Credential>optional

Credentials to be used in the state.

parsedWebhookData

Stringoptional

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

pipelineParameters

Array<PipelineParameter>optional

The list of pipeline parameters.

priority

Stringoptional

The priority of jobs launched by the release.

Possible values: "low", "normal", "high", "highest"

scheduleName

Stringoptional

Name for the schedule; must be unique among all schedules for the project.

stagesToRun

Array<Unknown>optional

One or more stages to run in a pipeline associated with the release.

startingStage

Stringoptional

The name of the starting stage.

startingTask

Stringoptional

The name of the starting task.

startingTaskStage

Stringoptional

The name of the stage containing starting task.

webhookData

Stringoptional

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

Stringoptional

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.startRelease(
  projectName: "test-projectName",
  releaseName: "test-releaseName"
  /* optional arguments */
)▼