Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Pipeline

3 minute readReference

abortAllPipelineRuns

Aborts all pipeline runs associated with a release.

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline.

force

Boolean

If true running tasks are force aborted.

releaseName

String

The name of the release.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.abortAllPipelineRuns(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

createPipeline

Creates a new pipeline for a project.

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline. (Required)

assigneesForSkipStage

String array

A list of users who can skip stages at runtime.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

disableMultipleActiveRuns

Boolean

Boolean flag showing if option to run multiple pipelines simultaneously is disabled.

disableRestart

Boolean

True to disable restart the pipeline.

enabled

Boolean

True to enable the pipeline.

overrideWorkspace

Boolean

If true and workspaceName is not null, then all tasks use pipeline’s workspace.

pipelineRunNameTemplate

String

Template used to determine the default name for pipelines on startup.

releaseName

String

The name of the release.

skipStageMode

String

The flag to indicate if stages can be skipped at runtime.

type

String

Type of pipeline.

workspaceName

String

The name of the default workspace for this pipeline.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createPipeline(
                projectName: 'test-projectName',
                pipelineName: 'test-pipelineName'
                /* optional arguments */)
▼

deletePipeline

Deletes a pipeline in a project.

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline. (Required)

releaseName

String

The name of the release.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePipeline(
                projectName: 'test-projectName',
                pipelineName: 'test-pipelineName'
                /* optional arguments */)
▼

getPipeline

Retrieves a pipeline by its name.

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)

releaseName

String

The name of the release.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPipeline(
                pipelineName: 'test-pipelineName',
                projectName: 'test-projectName'
                /* optional arguments */)
▼

getPipelines

Retrieves all the pipelines.

Arguments

Argument Name Type Description

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPipelines(
                projectName: 'test-projectName')
▼

modifyPipeline

Modifies an existing pipeline.

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline. (Required)

assigneesForSkipStage

String array

A list of users who can skip stages at runtime.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

disableMultipleActiveRuns

Boolean

Boolean flag showing if option to run multiple pipelines simultaneously is disabled.

disableRestart

Boolean

True to disable restart the pipeline.

enabled

Boolean

True to enable the pipeline.

newName

String

New name for an existing object that is being renamed.

overrideWorkspace

Boolean

If true and workspaceName is not null, then all tasks use pipeline’s workspace.

pipelineRunNameTemplate

String

Template used to determine the default name for pipelines on startup.

releaseName

String

The name of the release.

skipStageMode

String

The flag to indicate if stages can be skipped at runtime.

type

String

Type of pipeline.

workspaceName

String

The name of the default workspace for this pipeline.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPipeline(
                projectName: 'test-projectName',
                pipelineName: 'test-pipelineName'
                /* optional arguments */)
▼
personapage
plugin