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

ProcessStep

8 minute readReference

createProcessStep

Creates a new process step.

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)

serviceName

String

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

actionLabelText

String

The Json derived action label text

actualParameters

ActualParameter array

Actual parameters passed to an invoked subprocedure or process.

afterLastRetry

String

Specifies error handling for the auto retry step.

afterProcessStep

String

If specified, the process step will be placed after the named process step.

allowSkip

Boolean

When enabled, manual process step can be skipped.

alwaysRun

Boolean

True means this step will run even if preceding steps fail in a way that aborts the job

applicationName

String

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

applicationTierName

String

If references an application tier, the name of the application tier

assignees

String array

A list of assignees who receive the notification.

beforeProcessStep

String

If specified, the process step will be placed before the named process step.

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.

componentRollback

Boolean

When enabled, rollback will be performed only for the components that were not deployed successfully.

credentialName

String

The name of the credential object.

dependencyJoinType

String

Join type for incoming dependencies.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

disableFailure

Boolean

True means a manual process step cannot be failed.

emailConfigName

String

The name of email configuration

errorHandling

String

Specifies error handling for this step.

includeCompParameterRef

Boolean

True if the actual parameters should be generated from component properties. Works for artifact components only.

instruction

String

Instruction associated with the manual process step.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

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

notificationEnabled

Boolean

True means this email notification is enabled, false otherwise.

notificationTemplate

String

Email notification template for process step.

processStepType

String

Defines type of the process step

retryCount

Integer

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

Integer

If the retry is auto, specify the interval in seconds after which retry should be attempted.

retryType

String

Type of retry when process step fails. Is one of 'auto' or 'manual'

rollbackSnapshot

String

Name of Snapshot to be used for rollback.

rollbackType

String

The type of the rollback.

rollbackUndeployProcess

String

Name of the undeploy process to be used during rollback.

serviceApplicationName

String

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

skipRollbackIfUndeployFails

Boolean

When enabled, rollback will be performed only for the components that were successfully undeployed.

smartRollback

Boolean

Smart deploy flag to be used during rollback is triggered

subcomponent

String

If referencing a component process, the name of the component.

subcomponentApplicationName

String

If referencing a component process, the name of the component application (if not project scoped).

subcomponentProcess

String

If referencing a component process, the name of the component process.

submicroservice

String

If referencing a microservice, the name of the microservice.

submicroserviceProcess

String

If referencing a microservice process, the name of the microservice process.

subprocedure

String

If referencing a procedure, the name of the procedure.

subproject

String

If referencing a procedure, the name of the procedure’s project.

subservice

String

Deprecated: Deprecated due to microservice model changes If referencing a service, the name of the service.

subserviceProcess

String

Deprecated: Deprecated due to microservice model changes If referencing a service process, the name of the service process.

timeLimit

String

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

String

Units for step time limit: seconds, minutes, or hours.

useUtilityResource

Boolean

True means that step will run on utility reasorce instead of a tier

utilityResourceName

String

Utility reasorce name

workingDirectory

String

Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job’s workspace.

workspaceName

String

The name of the workspace.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteProcessStep

Deletes an application or component process step.

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)

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

If specified, the microservice is scoped to an application.

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.deleteProcessStep(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName'
                /* optional arguments */)
▼

getProcessStep

Get an application or service or component process step.

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)

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

If specified, the microservice is scoped to an application.

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.getProcessStep(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName'
                /* optional arguments */)
▼

getProcessSteps

Retrieve all process steps in an application or service or component 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

If specified, the microservice is scoped to an application.

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.getProcessSteps(
                projectName: 'test-projectName',
                processName: 'test-processName'
                /* optional arguments */)
▼

modifyProcessStep

Modifies an existing process step.

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)

serviceName

String

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

actionLabelText

String

The Json derived action label text

actualParameters

ActualParameter array

Actual parameters passed to an invoked subprocedure or process.

afterLastRetry

String

Specifies error handling for the auto retry step.

afterProcessStep

String

If specified, the process step will be placed after the named process step.

allowSkip

Boolean

When enabled, manual process step can be skipped.

alwaysRun

Boolean

True means this step will run even if preceding steps fail in a way that aborts the job

applicationName

String

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

applicationTierName

String

If references an application tier, the name of the application tier

assignees

String array

A list of assignees who receive the notification.

beforeProcessStep

String

If specified, the process step will be placed before the named process step.

clearActualParameters

Boolean

True if the step should remove all actual parameters.

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.

componentRollback

Boolean

When enabled, rollback will be performed only for the components that were not deployed successfully.

credentialName

String

The name of the credential object.

dependencyJoinType

String

Join type for incoming dependencies.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

disableFailure

Boolean

True means a manual process step cannot be failed.

emailConfigName

String

The name of email configuration

errorHandling

String

Specifies error handling for this step.

includeCompParameterRef

Boolean

True if the actual parameters should be generated from component properties. Works for artifact components only.

instruction

String

Instruction associated with the manual process step.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

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

newName

String

New name for an existing object that is being renamed.

notificationEnabled

Boolean

True means this email notification is enabled, false otherwise.

notificationTemplate

String

Email notification template for process step.

processStepType

String

Defines type of the process step

retryCount

Integer

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

Integer

If the retry is auto, specify the interval in seconds after which retry should be attempted.

retryType

String

Type of retry when process step fails. Is one of 'auto' or 'manual'

rollbackSnapshot

String

Name of Snapshot to be used for rollback.

rollbackType

String

The type of the rollback.

rollbackUndeployProcess

String

Name of the undeploy process to be used during rollback.

serviceApplicationName

String

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

skipRollbackIfUndeployFails

Boolean

When enabled, rollback will be performed only for the components that were successfully undeployed.

smartRollback

Boolean

Smart deploy flag to be used during rollback is triggered

subcomponent

String

If referencing a component process, the name of the component.

subcomponentApplicationName

String

If referencing a component process, the name of the component application (if not project scoped).

subcomponentProcess

String

If referencing a component process, the name of the component process.

submicroservice

String

If referencing a microservice, the name of the microservice.

submicroserviceProcess

String

If referencing a microservice process, the name of the microservice process.

subprocedure

String

If referencing a procedure, the name of the procedure.

subproject

String

If referencing a procedure, the name of the procedure’s project.

subservice

String

Deprecated: Deprecated due to microservice model changes If referencing a service, the name of the service.

subserviceProcess

String

Deprecated: Deprecated due to microservice model changes If referencing a service process, the name of the service process.

timeLimit

String

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

String

Units for step time limit: seconds, minutes, or hours.

useUtilityResource

Boolean

True means that step will run on utility reasorce instead of a tier

utilityResourceName

String

Utility reasorce name

workingDirectory

String

Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job’s workspace.

workspaceName

String

The name of the workspace.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyProcessStep(
                projectName: 'test-projectName',
                processName: 'test-processName',
                processStepName: 'test-processStepName'
                /* optional arguments */)
▼
processdependency
project