Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

WaitDependency

3 minute readReference

createWaitDependency

Create a wait dependency for a stage or task

Arguments

Argument NameTypeDescription

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

allowSkip

Boolean

The flag to indicate if a dependency can be skipped at runtime.

assigneesForSkip

String array

A list of assignees who can skip a dependency at runtime.

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

waitDependencyName

String

The name of the wait dependency.

waitForTriggeredPipelines

Boolean

The flag to indicate that dependency should be created on all triggered pipelines.

waitForTriggeredReleases

Boolean

The flag to indicate that dependency should be created on all triggered releases.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteWaitDependency

Create an WaitDependency for a stage or task

Arguments

Argument NameTypeDescription

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getWaitDependency

Get a wait dependency for a stage or task

Arguments

Argument NameTypeDescription

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyWaitDependency

Modify a wait dependency for a stage or task

Arguments

Argument NameTypeDescription

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

allowSkip

Boolean

The flag to indicate if a dependency can be skipped at runtime.

assigneesForSkip

String array

A list of assignees who can skip a dependency at runtime.

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.

newName

String

New name for an existing object that is being renamed.

releaseName

String

The name of the release

taskName

String

The name of the task

waitForTriggeredPipelines

Boolean

The flag to indicate that dependency should be created on all triggered pipelines.

waitForTriggeredReleases

Boolean

The flag to indicate that dependency should be created on all triggered releases.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyWaitDependency(
                projectName: 'test-projectName',
                /* optional arguments */)
utilityresource
webhookresult