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
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

ProcessDependency

3 minute readReference

createProcessDependency

Creates a dependency between two process steps.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

The name of the process. (Required)

processStepName

String

The name of the process step. (Required)

targetProcessStepName

String

The name of the target process step. (Required)

serviceName

String

Deprecated: Deprecated due to microservice model changes The name of the service, if the process is owned by a service.

applicationName

String

The name of the application, if the process is owned by an application.

branchCondition

String

Branch Condition.

branchConditionName

String

Branch Condition Name.

branchConditionType

String

Branch Condition Type.

branchType

String

Branch Type.

componentApplicationName

String

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

componentName

String

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

microserviceApplicationName

String

Name of the application containing the microservice.

microserviceName

String

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

serviceApplicationName

String

Deprecated: Deprecated due to microservice model changes If specified, the service is scoped to this application not the project.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createProcessDependency(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName',
                targetProcessStepName: 'test-targetProcessStepName'
                /* optional arguments */)

deleteProcessDependency

Deletes a dependency between two process steps.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

The name of the process. (Required)

processStepName

String

The name of the process step. (Required)

targetProcessStepName

String

The name of the target process step. (Required)

serviceName

String

Deprecated: Deprecated due to microservice model changes The name of the service, if the process is owned by a service.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

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

componentName

String

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

microserviceApplicationName

String

Name of the application containing the microservice.

microserviceName

String

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

serviceApplicationName

String

Deprecated: Deprecated due to microservice model changes If specified, the service is scoped to this application not the project.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteProcessDependency(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName',
                targetProcessStepName: 'test-targetProcessStepName'
                /* optional arguments */)

getProcessDependencies

Retrieves all dependencies for a process.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

The name of the process. (Required)

serviceName

String

Deprecated: Deprecated due to microservice model changes The name of the service, if the process is owned by a service.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

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

componentName

String

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

microserviceApplicationName

String

Name of the application containing the microservice.

microserviceName

String

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

serviceApplicationName

String

Deprecated: Deprecated due to microservice model changes If specified, the service is scoped to this application not the project.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyProcessDependency

Modifies a dependency between two process steps.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

The name of the process. (Required)

processStepName

String

The name of the process step. (Required)

targetProcessStepName

String

The name of the target process step. (Required)

serviceName

String

Deprecated: Deprecated due to microservice model changes The name of the service, if the process is owned by a service.

applicationName

String

The name of the application, if the process is owned by an application.

branchCondition

String

Branch Condition.

branchConditionName

String

Branch Condition Name.

branchConditionType

String

Branch Condition Type.

branchType

String

Branch Type.

componentApplicationName

String

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

componentName

String

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

microserviceApplicationName

String

Name of the application containing the microservice.

microserviceName

String

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

serviceApplicationName

String

Deprecated: Deprecated due to microservice model changes If specified, the service is scoped to this application not the project.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyProcessDependency(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName',
                targetProcessStepName: 'test-targetProcessStepName'
                /* optional arguments */)
process
processstep