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

Process step

7 minute readReference

completeManualProcessStep

Completes a manual process step.

Arguments

Argument Name Type Description

jobStepId

UUID

(Required) The primary key for a job step.

action

ManualProcessStepStatus

The type of action to be taken on the manual process step or manual task or gate task.

actualParameters

Map

Actual parameters passed to the specified job step.

comment

String

Evidence provided while taking an action on the manual process step.

Positional arguments

jobStepId

Usage

ec-perl

$cmdr->completeManualProcessStep(<jobStepId>, {<optionals>});
▼

ectool

ectool completeManualProcessStep jobStepId, [optionals]
▼

createProcessStep

Creates a new process step.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

(Required) The name of the process.

processStepName

String

(Required) The name of the process step.

actionLabelText

String

The Json derived action label text.

actualParameters

Map

Actual parameters passed to an invoked subprocedure or process.

afterLastRetry

AfterLastRetryErrorHandling

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

Collection

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

ProcessDependencyJoinType

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

ErrorHandling

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

ProcessStepType

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

RetryType

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

rollbackSnapshot

String

Name of Snapshot to be used for rollback.

rollbackType

RollbackProcessStepType

The type of the rollback.

rollbackUndeployProcess

String

Name of the undeploy process to be used during rollback.

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.

timeLimit

String

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

timeLimitUnits

TimeLimitUnits

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

useUtilityResource

Boolean

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

utilityResourceName

String

Utility resource 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.

Positional arguments

projectName, processName, processStepName

Usage

ec-perl

$cmdr->createProcessStep(<projectName>, <processName>, <processStepName>, {<optionals>});
▼

ectool

ectool createProcessStep projectName,  processName,  processStepName, [optionals]
▼

deleteProcessStep

Deletes an application or component process step.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

(Required) The name of the process.

processStepName

String

(Required) The name of the process step.

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.

Positional arguments

projectName, processName, processStepName

Usage

ec-perl

$cmdr->deleteProcessStep(<projectName>, <processName>, <processStepName>, {<optionals>});
▼

ectool

ectool deleteProcessStep projectName,  processName,  processStepName, [optionals]
▼

getProcessStep

Retrieves an application or component process step.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

(Required) The name of the process.

processStepName

String

(Required) The name of the process step.

applicationEntityRevisionId

UUID

The revision ID 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.

Positional arguments

projectName, processName, processStepName

Usage

ec-perl

$cmdr->getProcessStep(<projectName>, <processName>, <processStepName>, {<optionals>});
▼

ectool

ectool getProcessStep projectName,  processName,  processStepName, [optionals]
▼

getProcessSteps

Retrieves all the process steps in an application or component process.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

(Required) The name of the process.

applicationEntityRevisionId

UUID

The revision ID 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.

Positional arguments

projectName, processName

Usage

ec-perl

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

ectool

ectool getProcessSteps projectName,  processName, [optionals]
▼

modifyProcessStep

Modifies an existing process step.

Arguments

Argument Name Type Description

projectName

String

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

processName

String

(Required) The name of the process.

processStepName

String

(Required) The name of the process step.

actionLabelText

String

The Json derived action label text.

actualParameters

Map

Actual parameters passed to an invoked subprocedure or process.

afterLastRetry

AfterLastRetryErrorHandling

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

Collection

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

If true, 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

ProcessDependencyJoinType

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

ErrorHandling

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

The 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

ProcessStepType

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

RetryType

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

rollbackSnapshot

String

Name of Snapshot to be used for rollback.

rollbackType

RollbackProcessStepType

The type of the rollback.

rollbackUndeployProcess

String

Name of the undeploy process to be used during rollback.

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.

timeLimit

String

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

timeLimitUnits

TimeLimitUnits

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

useUtilityResource

Boolean

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

utilityResourceName

String

Utility resource 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.

Positional arguments

projectName, processName, processStepName

Usage

ec-perl

$cmdr->modifyProcessStep(<projectName>, <processName>, <processStepName>, {<optionals>});
▼

ectool

ectool modifyProcessStep projectName,  processName,  processStepName, [optionals]
▼

retryProcessStep

Allows a job step that is waiting on manual input to perform a retry.

Arguments

Argument Name Type Description

jobStepId

UUID

(Required) The primary key for a job step.

action

RetryTaskAction

Action to execute: rerun (default), skip or fail the process step.

comment

String

Comment provided while retry an action on the manual process step.

Positional arguments

jobStepId

Usage

ec-perl

$cmdr->retryProcessStep(<jobStepId>, {<optionals>});
▼

ectool

ectool retryProcessStep jobStepId, [optionals]
▼
Process dependency
Project