Using the Perl API
Perl API reference
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 managementInstalling 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
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

EventSubscription

6 minute readReference

createEventSubscription

Creates a new list of event subscriptions.

Arguments

Argument Name Type Description

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container 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

String

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

flowRuntimeStateId

String

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

String

The type of the gate.

groupNames

String array

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

jobStepId

String

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

String array

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createEventSubscription(
                notifierName: 'test-notifierName'
                /* optional arguments */)

deleteEventSubscription

Delete a list of event subscriptions

Arguments

Argument Name Type Description

notifierName

String

The name of the email notifier. (Required)

jobId

String

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

userNames

String array

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

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

String

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

flowRuntimeStateId

String

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

String

The type of the gate.

groupNames

String array

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

jobStepId

String

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEventSubscription(
                notifierName: 'test-notifierName',
                /* optional arguments */)

getEventSubscription

Get an event subscription for a given user or group.

Arguments

Argument Name Type Description

notifierName

String

The name of the email notifier. (Required)

jobId

String

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

userName

String

The names of the user who receives the notification.

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

String

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

flowRuntimeStateId

String

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

String

The type of the gate.

groupName

String

The name of the group which receives the notification.

jobStepId

String

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEventSubscription(
                notifierName: 'test-notifierName',
                /* optional arguments */)

getEventSubscriptions

Retrieve a list event subscriptions for a specified event

Arguments

Argument Name Type Description

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container 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

String

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

flowRuntimeStateId

String

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

String

The type of the gate.

jobStepId

String

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEventSubscriptions(
                notifierName: 'test-notifierName'
                /* optional arguments */)

modifyEventSubscription

Modifies a list of event subscriptions.

Arguments

Argument Name Type Description

notifierName

String

The name of the email notifier. (Required)

jobId

String

The primary key or name of the job container 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

String

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

flowRuntimeStateId

String

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

String

The type of the gate.

groupNames

String array

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

jobStepId

String

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

String array

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyEventSubscription(
                notifierName: 'test-notifierName'
                /* optional arguments */)
envtempltierresourcetemplmapping
flowruntime