Using the Perl API
IntroductionACL 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 managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuserutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Wait Dependencies

8 minute readReference

completeRuntimeWaitDependency

Manually force the specific wait dependency to complete for the specified source pipeline runtime. You must specify the source pipeline or pipeline object and the dependent pipeline or pipeline object.

Arguments Descriptions

Specify the source pipeline object that defines the wait dependency in one of the following ways.

flowRuntimeId

--projectName <project> --pipelineName <pipeline>

--projectName <project> --releaseName <release> --pipelineName <pipeline>

The source pipeline runtime for which to complete wait dependencies. Use getPipelineRuntimes to get flowRuntimeId.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, wait dependencies for the specified runtime pipeline are cleared.

Argument type: String

Specify the dependent pipeline in one of the following ways.

runtimeWaitDependencyName

dependentFlowRuntimeId

--dependentProjectName <project> --dependentPipelineName <pipeline>

--dependentProjectName <project> --dependentReleaseName <release>

--dependentPipelineName <pipeline>
▼

The specification of dependent pipeline. Use getRuntimeWaitDependencies to get runtimeWaitDependencyName or dependentFlowRuntimeId.

This forces the matching dependency to complete. Used when entire pipeline is dependent. For depencencies with finer granularity, qualify this with a pipeline object, below.

If the dependent release pipeline is specified,

Argument type: String

Specify the dependent pipeline object for the wait dependency, as required.

--dependentStageName <stage>

--dependentStageName <stage> --dependentGateType <PRE|POST>

--dependentStageName <stage> --dependentTaskName <task>

(Optional) Used to specify a finer-grained dependent pipeline object: a dependent stage object, a dependent stage gate object, or a dependent task, respectively.

Only available for dependent, non-release pipelines.

If not specified, wait dependencies for the specified dependent runtime pipeline are cleared.

Argument type: String

Positional arguments

See table above.

Response

Returns a runtimeWaitDependency object.

ec-perl

syntax: $cmdr->completeRuntimeWaitDependency(<sourcePipeline> <dependentPipeline> {<optionals>});

Example

$cmdr->completeRuntimeWaitDependency(flowRuntimeId => 0509945d-e6ab-11e8-8b28-10653022f566, runtimeWaitDependencyName => 05194c41-e6ab-11e8-8b28-10653022f566);
▼

ectool

syntax: ectool completeRuntimeWaitDependency <sourcePipeline> <dependentPipeline> [<optionals>]

Example

ectool completeRuntimeWaitDependency --flowRuntimeId 0509945d-e6ab-11e8-8b28-10653022f566 --runtimeWaitDependencyName 05194c41-e6ab-11e8-8b28-10653022f566
▼

Back to top

createWaitDependency

Creates a new wait dependency between a pipeline and sub-pipeline.

You must specify ProjectName, a source pipeline or pipeline object, and a dependent pipeline or pipeline object. In lieu of a dependent pipeline, specify wait for triggered pipelines or triggered release pipelines.

Arguments Descriptions

projectName

The name for the project that belongs to a pipeline or release..

Argument type: String

waitDependencyName

(Optional) The name of this wait dependency. This is used in other wait dependency API calls to reference this particular wait dependency configuration. System generated if not provided.

Argument type: String

allowSkip

(Optional) Runtime skip flag to allow skipping a dependency. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

If not specified, the flag is set to false.

Argument type: Boolean

assigneesForSkip

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

If none specified, no one can skip.

Argument type: String array

Specify the source pipeline object that defines the wait dependency in one of the following ways.

flowRuntimeId

--projectName <project> --pipelineName <pipeline>

--projectName <project> --releaseName <release> --pipelineName <pipeline>

The source pipeline for the wait dependency.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, the wait dependency is created for the entire pipeline.

Argument type: String

Specify the dependent pipeline in one of the following ways.

--dependentProjectName <project> --dependentPipelineName <pipeline>

--dependentProjectName <project> --dependentReleaseName <release> --dependentPipelineName <pipeline>

The dependent pipeline.

If used alone, the entire pipeline is dependent. For dependencies with finer granularity, qualify this with a pipeline object, below.

If a dependent release pipeline is specified, no finer granularity can be specified.

Argument type: String

Specify the dependent pipeline object for the wait dependency, as required.

--dependentStageName <stage>

--dependentStageName <stage> --dependentGateType <PRE|POST>

--dependentStageName <stage> --dependentTaskName <task>

(Optional) Used to specify a finer-grained dependent pipeline object: a dependent stage object, a dependent stage gate object, or a dependent task, respectively.

Only available for dependent, non-release pipelines.

Argument type: String

Use to create a wait dependency for all triggered pipeline configured from this pipeline or release task. Use in lieu of a source pipeline dependency.

waitForTriggeredPipelines

(Optional) The flag to create the dependency on all triggered pipelines. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

Argument type: Boolean

waitForTriggeredReleases

(Optional) The flag to to create the dependency on all triggered releases. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

Argument type: Boolean

Positional arguments

projectName

Response

Returns a waitDependency object.

ec-perl

syntax: $cmdr->createWaitDependency(<projectName>, {<optionals>});

Example—for triggered pipelines

$cmdr->createWaitDependency(Default,
        {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      waitForTriggeredPipelines => 1});
▼

Example—for dependent pipelines

$cmdr->createWaitDependency(Default,
        {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      dependentPipelineName => "Pipeline B"
      dependentStageName ==> "QA"
});
▼

ectool

syntax: ectool createWaitDependency <projectName> [optionals]

Example—for triggered pipelines

ectool createWaitDependency Default --pipelineName "Pipeline A"
  --stageName "DEV"
  --taskName "Task 1"
  --waitForTriggeredPipelines 1
▼

Example—for dependent pipelines

ectool createWaitDependency Default --pipelineName "Pipeline A"
  --stageName "DEV"
  --taskName "Task 1"
  --dependentPipelineName "Pipeline B"
  --dependentStageName "QA"
▼

Back to top

deleteWaitDependency

Deletes the specified wait dependency from the pipeline object definition.

You must specify projectName.

Arguments Descriptions

Specify the source pipeline object that defines the wait dependency in one of the following ways.

projectName --pipelineName <pipeline>

projectName --releaseName <release> --pipelineName <pipeline>

The source pipeline for the wait dependency.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, the wait dependency is created for the entire pipeline.

Argument type: String

Specify the dependent pipeline in one of the following ways.

--waitDependencyName <waitDependencyName>

--dependentProjectName <project> --dependentPipelineName <pipeline>

--dependentProjectName <project> --dependentReleaseName <release> --dependentPipelineName <pipeline>

The dependent pipeline.

If used alone, the entire pipeline is dependent. For dependencies with finer granularity, qualify this with a pipeline object, below.

If a dependent release pipeline is specified, no finer granularity can be specified.

Argument type: String

Specify the dependent pipeline object for the wait dependency, as required.

--dependentStageName <stage>

--dependentStageName <stage> --dependentGateType <PRE|POST>

--dependentStageName <stage> --dependentTaskName <task>

(Optional) Used to specify a finer-grained dependent pipeline object: a dependent stage object, a dependent stage gate object, or a dependent task, respectively.

Only available for dependent, non-release pipelines.

Argument type: String

Positional arguments

projectName

Response

Null is returned.

ec-perl

syntax: $cmdr->deleteWaitDependency(<projectName>, {<optionals>});

Example

$cmdr->deleteWaitDependency(Default,
        {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      dependentPipelineName => "Pipeline B"
      dependentStageName ==> "QA"
});
▼

ectool

syntax: ectool cdeleteWaitDependency <projectName> [optionals]

Example

ectool deleteWaitDependency Default --pipelineName "Pipeline A"
  --stageName "DEV"
  --taskName "Task 1"
  --dependentPipelineName "Pipeline B"
  --dependentStageName "QA"
▼

Back to top

getRuntimeWaitDependencies

Retrieves runtime wait dependencies for the specified pipeline runtime or pipeline runtime object.

You must specify flowRuntimeId and the source runtime pipeline object.

Arguments Descriptions

flowRuntimeId

The source pipeline runtime for which to get wait dependencies. Use getPipelineRuntimes to get flowRuntimeId.

Argument type: String

Use to specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, wait dependencies for the specified runtime pipeline are returned.

Argument type: String

Positional arguments

flowRuntimeId

Response

Returns a runtimeWaitDependency object for the specified pipeline object. If the pipeline object does not contain a wait dependency, NULL is returned.

ec-perl

syntax: $cmdr->getRuntimeWaitDependencies(<flowRuntimeId>,{<pipeline object>});

Example

$cmdr->getRuntimeWaitDependencies(0509945d-e6ab-11e8-8b28-10653022f566,{stageName => "DEV"});
▼
$cmdr->getRuntimeWaitDependencies(0509945d-e6ab-11e8-8b28-10653022f566,{stageName => "DEV", taskName => "TASK 1"});
▼

ectool

syntax: ectool getRuntimeWaitDependencies flowRuntimeId <pipeline object>

Example

ectool getRuntimeWaitDependencies 0509945d-e6ab-11e8-8b28-10653022f566 --stageName DEV
▼
ectool getRuntimeWaitDependencies 0509945d-e6ab-11e8-8b28-10653022f566 --stageName DEV --taskName "TASK 1"
▼

Back to top

getWaitDependency

Retrieves the specified wait depencency.

You must specify…​projectName+[releaseName]+pipelineName

Arguments Descriptions

Specify the source pipeline object that defines the wait dependency in one of the following ways.

projectName --pipelineName <pipeline>

projectName --releaseName <release> --pipelineName <pipeline>

The source pipeline for the wait dependency.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, the wait dependency is created for the entire pipeline.

Argument type: String

Specify the dependent pipeline in one of the following ways.

--waitDependencyName <waitDependencyName>

--dependentProjectName <project> --dependentPipelineName <pipeline>

--dependentProjectName <project> --dependentReleaseName <release> --dependentPipelineName <pipeline>

The dependent pipeline.

If used alone, the entire pipeline is dependent. For dependencies with finer granularity, qualify this with a pipeline object, below.

If a dependent release pipeline is specified, no finer granularity can be specified.

Argument type: String

Specify the dependent pipeline object for the wait dependency, as required.

--dependentStageName <stage>

--dependentStageName <stage> --dependentGateType <PRE|POST>

--dependentStageName <stage> --dependentTaskName <task>

(Optional) Used to specify a finer-grained dependent pipeline object: a dependent stage object, a dependent stage gate object, or a dependent task, respectively.

Only available for dependent, non-release pipelines.

Argument type: String

Positional arguments

projectName

Response

Returns a waitDependency object.

ec-perl

syntax: $cmdr->createWaitDependency(<projectName>, {<optionals>});

Example

$cmdr->createWaitDependency(Default,
        {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      dependentPipelineName => "Pipeline B"
      dependentStageName ==> "QA"
}); ;
▼

ectool

syntax: ectool getWaitDependency <projectName> [optionals]

Example

ectool getWaitDependency Default
                         --pipelineName "Pipeline A"
                         --stageName "DEV"
                         --waitDependencyName c274565b-e2cc-11e8-a988-10653022f566
▼

Back to top

getWaitDependencies

Retrieves all wait depencencies for projectName.

Arguments Descriptions

Specify the source pipeline object that defines the wait dependency in one of the following ways.

projectName --pipelineName <pipeline>

projectName --releaseName <release> --pipelineName <pipeline>

The source pipeline for the wait dependency.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, the wait dependency is created for the entire pipeline.

Argument type: String

Positional arguments

projectName

Response

Returns zero or more waitDependency objects.

ec-perl

syntax: $cmdr->getWaitDependencies(<projectName>, {<optionals>});

Example

$cmdr->getWaitDependencies("Default", pipelineName => "Pipeline A" --stageName"DEV");
▼

ectool

syntax: ectool getWaitDependencies <projectName> [optionals]

Example

ectool getWaitDependencies Default --pipelineName "Pipeline A" --stageName "DEV"
▼

Back to top

modifyWaitDependency

Modifies an existing wait dependency.

You must specify projectName, source pipeline, and dependent pipeline.

Arguments Descriptions

waitDependencyName

(Optional) The name of this wait dependency. This is used in other wait dependency API calls to reference this particular wait dependency configuration. System generated if not provided.

Argument type: String

allowSkip

(Optional) Runtime skip flag to allow skipping a dependency. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

If not specified, the flag is set to false.

Argument type: Boolean

assigneesForSkip

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

If none specified, no one can skip.

Argument type: String array

newName

Modify waitDependencyName to a custom, user-defined name.

Specify the source pipeline object that defines the wait dependency in one of the following ways.

projectName --pipelineName <pipeline>

projectName --releaseName <release> --pipelineName <pipeline>

The source pipeline for the wait dependency.

Argument type: String

Specify the pipeline object that defines the wait dependency, as required.

--stageName <stage>

--stageName <stage> --gateType <PRE|POST>

--stageName <stage> --taskName <task>

(Optional) Used to specify a finer-grained pipeline object: a stage object, a stage gate object, or a task, respectively.

If not specified, the wait dependency is created for the entire pipeline.

Argument type: String

Specify the dependent pipeline in one of the following ways.

--waitDependencyName <waitDependencyName>

--dependentProjectName <project> --dependentPipelineName <pipeline>

--dependentProjectName <project> --dependentReleaseName <release> --dependentPipelineName <pipeline>

The dependent pipeline.

If used alone, the entire pipeline is dependent. For dependencies with finer granularity, qualify this with a pipeline object, below.

If a dependent release pipeline is specified, no finer granularity can be specified.

Argument type: String

Specify the dependent pipeline object for the wait dependency, as required.

--dependentStageName <stage>

--dependentStageName <stage> --dependentGateType <PRE|POST>

--dependentStageName <stage> --dependentTaskName <task>

(Optional) Used to specify a finer-grained dependent pipeline object: a dependent stage object, a dependent stage gate object, or a dependent task, respectively.

Only available for dependent, non-release pipelines.

Argument type: String

Use to create a wait dependency for all triggered pipeline configured from this pipeline or release task. Use in lieu of a source pipeline dependency.

waitForTriggeredPipelines

(Optional) The flag to create the dependency on all triggered pipelines. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

Argument type: Boolean

waitForTriggeredReleases

(Optional) The flag to to create the dependency on all triggered releases. < Boolean flag — 0|1|true|false >

When set to true or 1, dependency can be skipped at runtime.

When set to false or 0, dependency cannot be skipped at runtime.

Argument type: Boolean

Positional arguments

projectName

Response

Returns a waitDependency object.

ec-perl

syntax: $cmdr->modifyWaitDependency(<projectName>, {<optionals>});

Example—for triggered pipelines

$cmdr->modifyWaitDependency(Default,
      {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      waitForTriggeredPipelines => 1
         newname => "WaitDependency 1"
});
▼

Example—for dependent pipelines

$cmdr->modifyWaitDependency(Default,
        {pipelineName => "Pipeline A",
      stageName => "DEV",
      taskName => "Task 1",
      dependentPipelineName => "Pipeline B"
      dependentStageName => "QA",
         newname => "WaitDependency 1"
});
▼

ectool

syntax: ectool modify WaitDependency <projectName> [optionals]

Example—for triggered pipelines

ectool modifyWaitDependency Default --pipelineName "Pipeline A"
  --stageName "DEV"
  --taskName "Task 1"
  --waitForTriggeredPipelines 1
  --newname "WaitDependency 1"
▼

Example—for dependent pipelines

ectool ModifyWaitDependency Default --pipelineName "Pipeline A"
  --stageName "DEV"
  --taskName "Task 1"
  --dependentPipelineName "Pipeline B"
  --dependentStageName "QA"
  --newname "WaitDependency 1"
▼

Back to top

User and group management
Webhhook management