API error messages
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

Wait dependency

4 minute readReference

completeRuntimeWaitDependency

Manually forces the specific wait dependency to complete for the specified source pipeline runtime.

Arguments

Argument Name Type Description

dependentFlowRuntimeId

UUID

The UUID of the dependent flowRuntime.

dependentGateType

GateType

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.

flowRuntimeId

UUID

The UUID of the invoking flowRuntime.

gateType

GateType

The type of gate.

pipelineName

String

The name of the pipeline.

projectName

String

The name for the project that contains the wait dependency.

releaseName

String

The name of the release.

runtimeWaitDependencyName

String

The name of the runtimeWaitDependency.

stageName

String

The name of the stage.

taskName

String

The name of the task.

Positional arguments

None.

Usage

ec-perl

$cmdr->completeRuntimeWaitDependency({<optionals>});
▼

ectool

ectool completeRuntimeWaitDependency [optionals]
▼

createWaitDependency

Creates a wait dependency for a stage or task.

Arguments

Argument Name Type Description

projectName

String

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

allowSkip

Boolean

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

assigneesForSkip

Collection

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

dependentGateType

GateType

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

GateType

The type of gate.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

stageName

String

The name of the stage.

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.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool createWaitDependency projectName, [optionals]
▼

deleteWaitDependency

Deletes the specified wait dependency from the pipeline object definition.

Arguments

Argument Name Type Description

projectName

String

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

dependentGateType

GateType

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

GateType

The type of gate.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

stageName

String

The name of the stage.

taskName

String

The name of the task.

waitDependencyName

String

The name of the wait dependency.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool deleteWaitDependency projectName, [optionals]
▼

getRuntimeWaitDependencies

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

Arguments

Argument Name Type Description

flowRuntimeId

UUID

(Required) The UUID of the invoking flowRuntime.

gateType

GateType

The type of gate.

stageName

String

The name of the stage.

taskName

String

The name of the task.

Positional arguments

flowRuntimeId

Usage

ec-perl

$cmdr->getRuntimeWaitDependencies(<flowRuntimeId>, {<optionals>});
▼

ectool

ectool getRuntimeWaitDependencies flowRuntimeId, [optionals]
▼

getWaitDependencies

Retrieves all wait dependencies for projectName.

Arguments

Argument Name Type Description

projectName

String

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

gateType

GateType

The type of gate.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

stageName

String

The name of the stage.

taskName

String

The name of the task.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool getWaitDependencies projectName, [optionals]
▼

getWaitDependency

Retrieves the specified wait dependency.

Arguments

Argument Name Type Description

projectName

String

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

dependentGateType

GateType

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

GateType

The type of gate.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

stageName

String

The name of the stage.

taskName

String

The name of the task.

waitDependencyName

String

The name of the wait dependency.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getWaitDependency(<projectName>, {<optionals>});
▼

ectool

ectool getWaitDependency projectName, [optionals]
▼

modifyWaitDependency

Modifies an existing wait dependency.

Arguments

Argument Name Type Description

projectName

String

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

allowSkip

Boolean

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

assigneesForSkip

Collection

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

dependentGateType

GateType

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

GateType

The type of gate.

newName

String

The new name for an existing object that is being renamed.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

stageName

String

The name of the stage.

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.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool modifyWaitDependency projectName, [optionals]
▼
Utility resource
Webhook result