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

Trigger

5 minute readReference

createTrigger

Create a new trigger.

Arguments

Argument Name Type Description

projectName

String

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

triggerName

String

The name of the trigger (Required)

releaseName

String

The name of the release to run

actualParameters

ActualParameter array

Actual parameters passed to the invoked object.

applicationName

String

The name of the application that owns the trigger and the process that should be run.

catalogItemName

String

Name of the catalog item to invoke.

catalogName

String

Name of the catalog containing the catalog item to invoke.

credentialName

String

The name of the credential to use for impersonation.

description

String

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

enabled

Boolean

True to enable the task.

environmentName

String

The name of the environment used to determine where to run the process.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

environmentTemplateName

String

The name of the environment template used to determine the environment where to run the process.

environmentTemplateProjectName

String

Name for the project to which the environment template belongs to.

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

pipelineName

String

The name of the pipeline to run

pipelineParameters

PipelineParameter array

Pipeline parameters used by a release schedule to override the default parameters configured in the release

pluginKey

String

The key of the plugin to be used for trigger integration with 3rd-party system

pluginParameters

PluginParameter array

List of plugin parameters.

procedureName

String

The name of the procedure that owns the process to run.

processName

String

The name of the application process to invoke.

quietTimeMinutes

String

Specify how long in minutes should pass since last trigger event before the trigger will run.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

One or more rolling deploy phases to be used for deployment.

runDuplicates

Boolean

Specify whether a trigger should be run if the previously triggered process is still running.

serviceAccountName

String

The name of the service account associated with a webhook trigger

snapshotName

String

The name of the snapshot to be used to invoke the application process.

stagesToRun

String array

One or more stages to run in a pipeline.

tierResourceCounts

TierResourceCount array

Resource count per resource template tier

triggerType

String

A type of trigger

webhookName

String

Webhook name.

webhookSecret

String

Webhook secret.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteTrigger

Deletes a trigger

Arguments

Argument Name Type Description

projectName

String

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

triggerName

String

The name of the trigger (Required)

releaseName

String

The name of the release to run

applicationName

String

The name of the application that owns the trigger and the process that should be run.

catalogItemName

String

Name of the catalog item to invoke.

catalogName

String

Name of the catalog containing the catalog item to invoke.

pipelineName

String

The name of the pipeline to run

procedureName

String

The name of the procedure that owns the process to run.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getTrigger

Retrieve a trigger by name.

Arguments

Argument Name Type Description

projectName

String

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

triggerName

String

The name of the trigger (Required)

releaseName

String

The name of the release to run

applicationName

String

The name of the application that owns the trigger and the process that should be run.

catalogItemName

String

Name of the catalog item to invoke.

catalogName

String

Name of the catalog containing the catalog item to invoke.

pipelineName

String

The name of the pipeline to run

procedureName

String

The name of the procedure that owns the process to run.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getTriggers

Retrieve all triggers.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

The name of the release to run

applicationName

String

The name of the application that owns the trigger and the process that should be run.

catalogItemName

String

Name of the catalog item to invoke.

catalogName

String

Name of the catalog containing the catalog item to invoke.

pipelineName

String

The name of the pipeline to run

procedureName

String

The name of the procedure that owns the process to run.

validate

Boolean

If passed 1, then all validations check if the definition is complete and valid.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyTrigger

Modify an existing trigger.

Arguments

Argument Name Type Description

projectName

String

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

triggerName

String

The name of the trigger (Required)

releaseName

String

The name of the release to run

actualParameters

ActualParameter array

Actual parameters passed to the invoked object.

applicationName

String

The name of the application that owns the trigger and the process that should be run.

catalogItemName

String

Name of the catalog item to invoke.

catalogName

String

Name of the catalog containing the catalog item to invoke.

clearActualParameters

Boolean

Whether or not to clear actual parameters for this object.

clearPipelineParameters

Boolean

Whether or not to clear pipeline parameters for the trigger.

credentialName

String

The name of the credential to use for impersonation.

description

String

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

enabled

Boolean

True to enable the task.

environmentName

String

The name of the environment used to determine where to run the process.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

environmentTemplateName

String

The name of the environment template used to determine the environment where to run the process.

environmentTemplateProjectName

String

Name for the project to which the environment template belongs to.

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

newName

String

New name for an existing object that is being renamed.

pipelineName

String

The name of the pipeline to run

pipelineParameters

PipelineParameter array

Pipeline parameters used by a release schedule to override the default parameters configured in the release

pluginKey

String

The key of the plugin to be used for trigger integration with 3rd-party system

pluginParameters

PluginParameter array

List of plugin parameters.

procedureName

String

The name of the procedure that owns the process to run.

processName

String

The name of the application process to invoke.

quietTimeMinutes

String

Specify how long in minutes should pass since last trigger event before the trigger will run.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

One or more rolling deploy phases to be used for deployment.

runDuplicates

Boolean

Specify whether a trigger should be run if the previously triggered process is still running.

serviceAccountName

String

The name of the service account associated with a webhook trigger

snapshotName

String

The name of the snapshot to be used to invoke the application process.

stagesToRun

String array

One or more stages to run in a pipeline.

tierResourceCounts

TierResourceCount array

Resource count per resource template tier

triggerType

String

A type of trigger

webhookName

String

Webhook name.

webhookSecret

String

Webhook secret.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyTrigger(
                projectName: 'test-projectName',
                triggerName: 'test-triggerName'
                /* optional arguments */)
transitiondefinition
triggererrordetail