API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange 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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Email notifier

15 minute readReference

createEmailNotifier

Creates an email notifier attached to the specified object, such as a job, job step, project, procedure, application process or process step, or a workflow.

You must specify a notifierName and object locators for a job, job step, procedure, or procedure step.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.

configName

String

Name for an email configuration; or a text that - through property expansion - results into such an email configuration name.

description

String

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

destinations

String

A list of space-separated user names, email addresses or email aliases or a text that - through property expansion - results into such a list.

environmentNames

Collection

Name of the environments.

eventType

EventType

An enumeration of valid event categories recognized by the email notifiers.

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

formattingTemplate

String

String containing email formatting instructions for generating notifications.

gateType

GateType

The type of the gate.

groupNames

Collection

A list of names of the groups which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

notificationType

NotificationType

The notification type which will be stored to the ec_notificationType property.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

Collection

A list of names of the users who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->createEmailNotifier(<notifierName>, {<optionals>});
▼

ectool

ectool createEmailNotifier notifierName [optionals]
▼

createEventSubscription

Creates a list of event subscriptions.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

groupNames

Collection

A list of names of the groups which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

Collection

A list of names of the users who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->createEventSubscription(<notifierName>, {<optionals>});
▼

ectool

ectool createEventSubscription notifierName [optionals]
▼

deleteEmailNotifier

Deletes an email notifier from an object.

You must specify a notifierName, and you must specify locator arguments to find the email notifier you want to delete.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->deleteEmailNotifier(<notifierName>, {<optionals>});
▼

ectool

ectool deleteEmailNotifier notifierName [optionals]
▼

deleteEventSubscription

Deletes a list of event subscriptions.

You must specify a notifierName, and you must specify locator arguments to find the email notifier you want to delete.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

groupNames

Collection

A list of names of the groups which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

Collection

A list of names of the users who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->deleteEventSubscription(<notifierName>, {<optionals>});
▼

ectool

ectool deleteEventSubscription notifierName [optionals]
▼

getEmailNotifier

Retrieves an email notifier from a property sheet container.

You must specify a notifierName and object locators to identify the object where the notifier is attached.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->getEmailNotifier(<notifierName>, {<optionals>});
▼

ectool

ectool getEmailNotifier notifierName [optionals]
▼

getEmailNotifiers

Retrieves all email notifiers defined for the specified property sheet.

Arguments

Argument Name Type Description

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getEmailNotifiers [optionals]
▼

getEventSubscription

Retrieves an event subscription for the specified user or group.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

groupName

String

The name of the group which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userName

String

The names of the user who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->getEventSubscription(<notifierName>, {<optionals>});
▼

ectool

ectool getEventSubscription notifierName [optionals]
▼

getEventSubscriptions

Retrieves a list event subscriptions for a specified event.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->getEventSubscriptions(<notifierName>, {<optionals>});
▼

ectool

ectool getEventSubscriptions notifierName [optionals]
▼

modifyEmailNotifier

Modifies an email notifier in a property sheet container specified by an emailNotifierSelector.

Email notifiers are evaluated and sent based on the privileges of the notifier’s owner. Owner can be changed to the current user if that user has sufficient privileges to have deleted the notifier object and recreated it. Modify privileges on the admin system access control list is required.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.

configName

String

Name for an email configuration; or a text that - through property expansion - results into such an email configuration name.

description

String

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

destinations

String

A list of space-separated user names, email addresses or email aliases or a text that - through property expansion - results into such a list.

environmentNames

Collection

Name of the environments.

eventType

EventType

An enumeration of valid event categories recognized by the email notifiers.

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

formattingTemplate

String

String containing email formatting instructions for generating notifications.

gateType

GateType

The type of the gate.

groupNames

Collection

A list of names of the groups which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

newName

String

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

notificationType

NotificationType

The notification type which will be stored to the ec_notificationType property.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

Collection

A list of names of the users who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->modifyEmailNotifier(<notifierName>, {<optionals>});
▼

ectool

ectool modifyEmailNotifier notifierName [optionals]
▼

modifyEventSubscription

Modifies a list of event subscriptions.

Arguments

Argument Name Type Description

notifierName

String

(Required) The name of the email notifier.

applicationName

String

The name of the application which is related to the target email container (Process/ProcessStep).

componentName

String

The name of the component which is related to the target email container (Process/ProcessStep).

flowName

String

The name of the flow container of the email notifier.

flowRuntimeId

UUID

The primary key or name of the flowRuntime container of the email notifier.

flowRuntimeStateId

UUID

The primary key or name of the flowRuntimeState container of the email notifier.

flowStateName

String

The name of the flow container of the email notifier.

gateType

GateType

The type of the gate.

groupNames

Collection

A list of names of the groups which receives the notification.

jobId

String

The primary key or name of the job container of the email notifier.

jobStepId

UUID

The primary key of the job-step container of the email notifier.

pipelineName

String

The name of the pipeline container of the email notifier.

procedureName

String

The name of the procedure container of the email notifier.

processName

String

The name of the process container of the email notifier.

processStepName

String

The name of the process step container of the email notifier.

projectName

String

The name of the project container of the email notifier.

releaseName

String

The name of the release containing the pipeline.

stageName

String

The name of the stage container of the email notifier.

stateDefinitionName

String

The name of the state definition container of the email notifier.

stateName

String

The name of the state container of the email notifier.

stepName

String

The name of the step container of the email notifier.

userNames

Collection

A list of names of the users who receives the notification.

workflowDefinitionName

String

The name of the workflow definition container of the email notifier.

workflowName

String

The name of the workflow container of the email notifier.

Positional arguments

notifierName

Usage

ec-perl

$cmdr->modifyEventSubscription(<notifierName>, {<optionals>});
▼

ectool

ectool modifyEventSubscription notifierName [optionals]
▼

sendEmail

Facilitates sending an email from the command line or a command job step without setting up an email notifier. This API is more dynamic than an email notifier because you do not need to set up a template beforehand. This API also makes sending email attachments easier than using a notifier template.

Instead of, or in addition to, specifying a configName, any of the configuration options for an email configuration can be specified as options. These options are: mailHost, mailPort, mailFrom, mailUser, and mailUserPassword.

If both a configName and configuration options are specified, the specified options override values stored in the configuration. In this case, the user must have both Modify and Execute permissions on the configuration.

Specify the options you need to create the type of email message you want to send.

Arguments

Argument Name Type Description

attachment

Collection

Attachments for the email.

bcc

Collection

A user name or email address to include in the Bcc: header element.

cc

Collection

A user name or email address to include in the Cc: header element.

configName

String

The email configuration name.

credentialName

String

The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications.

credentialProjectName

String

The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications.

header

Collection

A raw RFC 822 header-line.

html

String

The html text body of the message.

inline

Collection

Inline attachments.

mailFrom

String

The email address used as the email sender address for CloudBees CD/RO notifications.

mailHost

String

Name of the email server host.

mailPort

Integer

The port number for the email service on the server.

mailProtocol

String

Name of the email transport protocol. Supported protocol names: SMTP, SMTPS.

mailUser

String

Name of the email user on behalf of which CloudBees CD/RO sends email notifications.

mailUserPassword

String

Password of the email user on behalf of which CloudBees CD/RO sends email notifications.

multipartMode

MultipartMode

The multipart message mode. Defaults to none for single part messages and mixedRelated for messages with multiple parts.

raw

String

A raw RFC 822 mail message including headers and body.

subject

String

The Subject header field of the message.

text

String

The plain text body of the message.

to

Collection

A user name or email address to include in the To: header element.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool sendEmail [optionals]
▼
Email configuration
Environment