Using the Perl API
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 managementGet application environment inventoryInstalling 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
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Process Dependency

6 minute readReference

createProcessDependency

Creates a dependency between two process steps.

Required arguments

projectName

Name of the project that must be unique among all projects.

String

processName

Name of the process.

String

processStepName

Name of the process step.

String

targetProcessStepName

Name of the target process step.

String

Optional arguments

applicationName

Name of the application containing the specified application process ( processName ). When you want to create a dependency between two application process steps, specify the name of the application ( applicationName ) containing the process. The application name must be unique among all projects.

String

branchCondition

Condition of the branch.

String

branchConditionName

Name of the branch condition.

String

branchConditionType

Type of the branch condition.

BranchConditionType

branchType

Type of the branch. Possible values are:

  • ALWAYS —Branch is taken regardless of the step outcome

  • ERROR —Branch is taken if the source step outcome is error

  • SUCCESS —Branch is taken if the source step outcome is success

BranchType.

componentApplicationName

Name of the application where the component ( componentName ) is located. When you want to create a dependency between two component process steps in a specific application, specify the component ( componentName ) and the application ( componentApplicationName ) where the component is located.

String

componentName

Name of the component containing the process steps. When you want to create a dependency between two component process steps in a specific application, specify the component ( componentName ) and application ( componentApplicationName ) where the component is located.

String

microserviceApplicationName

If specified, the microservice is scoped to this application, not the project.

String

microserviceName

The name of the microservice, if the process is owned by a microservice.

String

Response

Returns a process dependency object.

ec-perl

Syntax:

$<object>->createProcessDependency(<projectName>, <processName>, <processStepName>, <targetProcessStepName>, {<optionals>});
▼

Example:

To create a dependency between two component process steps in a master component:

$ec->createProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file'});
▼

To create a dependency between two component process steps in a specific application:

$ec->createProcessDependency'Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});
▼

To create a dependency between two application process steps:

$ec->createProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart'});
▼

ectool

Syntax:

ectool createProcessDependency <projectName> <processName> <processStepName> <targetProcessStepName> [optionals]
▼

Example:

To create a dependency between two component process steps in a master component:

ectool createProcessDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file'
▼

To create a dependency between two component process steps in a specific application:

ectool createProcessDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'
▼

To create a dependency between two application process steps:

ectool createProcessDependency  'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --applicationName 'Shopping Cart'
▼

deleteProcessDependency

Deletes a dependency between two process steps.

Required arguments

projectName

Name of the project that must be unique among all projects.

String

processName

Name of the process.

String

processStepName

Name of the process step.

String

targetProcessStepName

Name of the target process step.

String

Optional arguments

applicationName

Name of the application containing the specified application process ( processName ). When you want to delete a dependency between two application process steps, specify the name of the application ( applicationName ) containing the process. The application name must be unique among all projects.

String

componentApplicationName

Name of the application where the component ( componentName ) is located. When you want to delete a dependency between two component process steps in a specific application, specify the component ( componentName ) and the application ( componentApplicationName ) where the component is located.

String

componentName

Name of the component containing the process steps. When you want to delete a dependency between two component process steps in a specific application, specify the component ( componentName ) and application ( componentApplicationName ) where the component is located.

String

microserviceApplicationName

Name of the application to which the microservice containing the process is scoped.

String

microserviceName

The name of the microservice, if the process is owned by a microservice.

String

Response

None or a status OK message.

ec-perl

Syntax:

$<object>->deleteProcessDependency(<projectName>, <processName>, <processStepName>, <targetProcessStepName>, {<optionals>});
▼

Example:

To delete a dependency between two component process steps in a master component:

$ec->deleteProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file'});
▼

To delete a dependency between two component process steps in a specific application:

$ec->deleteProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});
▼

To delete a dependency between two application process steps:

$ec->deleteProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart'});
▼

ectool

Syntax:

ectool deleteProcessDependency <projectName> <processName> <processStepName> <targetProcessStepName> [optionals]
▼

Example:

To delete a dependency between two component process steps in a master component:

ectool deleteProcessDependency 'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --componentName 'WAR file'
▼

To create a dependency between two component process steps in a specific application:

ectool deleteProcessDependency 'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'
▼

To create a dependency between two application process steps:

ectool deleteProcessDependency  'Default' 'Deploy' 'Get WAR file' 'Copy WAR file' --applicationName 'Shopping Cart'
▼

getProcessDependencies

Retrieves all dependencies for a process.

Required arguments

projectName

Name of the project that must be unique among all projects.

String

processName

Name of the process.

String

Optional arguments

applicationEntityRevisionId

The revision ID of the versioned project.

UUID

applicationName

Name of the application containing the specified application process ( processName ). When you want to retrieve the dependencies between process steps, specify the name of the application ( applicationName ) containing the process. The application name must be unique among all projects.

String

componentApplicationName

Name of the application where the component ( componentName ) is located. When you want to retrieve the dependencies between component process steps in a specific application, specify the component ( componentName ) and the application ( componentApplicationName ) where the component is located.

String

componentName

Name of the component containing the process steps. When you want to retrieve the dependencies between component process steps in a specific application, specify the component ( componentName ) and the application ( componentApplicationName ) where the component is located.

String

microserviceApplicationName

Name of the application to which the microservice containing the process is scoped.

String

serviceEntityRevisionId

Revision ID of the versioned object.

UUID

microserviceName

The name of the microservice, if the process is owned by a microservice.

String

Response

Returns zero or more process dependency elements, including processDependencyId, processName, source, sourceProcessStepName, target, and targetProcessStepName.

ec-perl

Syntax:

$<object>->getProcessDependencies(<projectName>, <processName>, {<optionals>});
▼

Example:

To retrieve the dependencies between two component process steps in a master component:

$ec->getProcessDependencies('Default', 'Deploy', {componentName => 'WAR file'});
▼

To retrieve the dependencies between two component process steps in a specific application:

$ec->getProcessDependencies('Default', 'Deploy', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});
▼

To retrieve the dependencies between two application process steps:

$ec->getProcessDependencies('Default', 'Deploy', {applicationName => 'Shopping Cart'});
▼

ectool

Syntax:

ectool getProcessDependencies <projectName> <processName> [optionals]
▼

Example:

To retrieve the dependencies between two component process steps in a master component:

ectool getProcessDependencies 'Default' 'Deploy' --componentName 'WAR file'
▼

To retrieve the dependencies between two component process steps in a specific application:

ectool getProcessDependencies 'Default' 'Deploy' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'
▼

To retrieve the dependencies between two application process steps:

ectool getProcessDependencies  'Default' 'Deploy' --applicationName 'Shopping Cart'
▼

modifyProcessDependency

Modifies a dependency between two process steps.

Required arguments

projectName

Name of the project; must be unique among all projects.

String

processName

Name of the process.

String

processStepName

Name of the process step.

String

targetProcessStepName

Name of the target process step.

String

Optional arguments

applicationName

Name of the application containing the specified application process ( processName ). When you want to modify a dependency between two application process steps, specify the name of the application ( applicationName ) containing the process. The application name must be unique among all projects.

String

branchCondition

Condition of the branch.

String

branchConditionName

Name of the branch condition.

String

branchConditionType

Type of the branch condition.

BranchConditionType

branchType

Type of the branch. Possible values are:

  • ALWAYS —Branch is taken regardless of the step outcome

  • ERROR —Branch is taken if the source step outcome is error

  • SUCCESS —Branch is taken if the source step outcome is success

BranchType.

componentApplicationName

Name of the application where the component ( componentName ) is located. When you want to modify a dependency between two component process steps in a specific application, specify the component ( componentName ) and the application ( componentApplicationName ) where the component is located.

String

componentName

Name of the component containing the process steps. When you want to modify a dependency between two component process steps in a specific application, specify the component ( componentName ) and application ( componentApplicationName ) where the component is located.

String

microserviceApplicationName

Name of the application to which the microservice containing the process is scoped.

String

microserviceName

The name of the microservice, if the process is owned by a microservice.

String

Response

Returns an updated process dependency object.

ec-perl

Syntax:

$<object>->modifyProcessDependency(<projectName>, <processName>, <processStepName>, <targetProcessStepName>, {<optionals>});
▼

Example:

To modify a dependency between two component process steps in a master component:

$ec->modifyProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file', {componentName => 'WAR file', branchConditionName => 'Create new WAR file'});
▼

To modify a dependency between two component process steps in a specific application:

$ec->modifyProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart', branchConditionName => 'Create new WAR file'});
▼

To modify a dependency between two application process steps:

$ec->modifyProcessDependency('Default', 'Deploy', 'Get WAR file', 'Copy WAR file',  {applicationName => 'Shopping Cart', branchConditionName => 'Create new WAR file'});
▼

ectool

Syntax:

ectool modifyProcessDependency <projectName> <processName> <processStepName> <targetProcessStepName> [optionals]
▼

Example:

To modify a dependency between two component process steps in a master component:

ectool modifyProcessDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --branchConditionName  'Create new WAR file'
▼

To modify a dependency between two component process steps in a specific application:

ectool modifyProcessDependency 'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --componentName 'WAR file' --componentApplicationName 'Shopping Cart' --branchConditionName  'Create new WAR file'
▼

To modify a dependency between two application process steps:

ectool modifyProcessDependency  'Default' 'Deploy' 'Get WAR file', 'Copy WAR file' --applicationName 'Shopping Cart' --branchConditionName  'Create new WAR file'
▼
Process
Process step