Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
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

Tag

4 minute readReference

createTag

Creates a new tag.

Arguments

Argument NameTypeDescription

tagName

String

The tag name. (Required)

description

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createTag(
                tagName: 'test-tagName'
                /* optional arguments */)

deleteTag

Delete a tag.

Arguments

Argument NameTypeDescription

tagName

String

The tag name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteTag(
                tagName: 'test-tagName')

getTag

Find a tag by name.

Arguments

Argument NameTypeDescription

tagName

String

The tag name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getTag(
                tagName: 'test-tagName')

getTags

Retrieve all tags.

Arguments

Argument NameTypeDescription

applicationName

String

The name of the application

artifactName

String

The name of the artifact

artifactVersionName

String

The name of the artifact version.

catalogItemName

String

Name of the catalog item.

catalogName

String

Name of the catalog containing the catalog item.

ciBuildName

String

The name of ciBuild to associate with a tag link.

ciJobDetailName

String

The name of CIJobDetail that contains the CI Build.

componentName

String

The name of the component

entityId

String

Id of the entity to associate with an entity tag link.

entityType

String

The entity type to associate with an entity tag link.

environmentName

String

The name of the environment

environmentTemplateName

String

The name of the environment template

flowRuntimeId

String

Id of the flowRuntime to associate with a tag link.

gateType

String

The type of the gate.

includeApplicationComponents

Boolean

Flag to indicate if the application component needs to be included in the response.

jobId

String

Id of the job to associate with a tag link.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure

processName

String

The name of the process

processStepName

String

The name of the process step

projectName

String

The name of the project

releaseName

String

The name of the release

resourceName

String

The name of the resource

resourcePoolName

String

The name of the resourcePool

resourceTemplateName

String

The name of the resource template

stageName

String

The name of the stage

stepName

String

The name of the procedure step

taskName

String

The name of the task

triggerName

String

The name of the trigger

workItemId

String

Id for the work item to associate with a tag link

workflowDefinitionName

String

The name of the workflow definition

workflowId

String

Id of the workflow to associate with a tag link.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getTags(
                /* optional arguments */)

modifyTag

Modify an existing tag.

Arguments

Argument NameTypeDescription

tagName

String

The tag name. (Required)

description

String

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

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyTag(
                tagName: 'test-tagName'
                /* optional arguments */)

tagObject

Add a tag to an object.

Arguments

Argument NameTypeDescription

applicationName

String

The name of the application

artifactName

String

The name of the artifact

artifactVersionName

String

The name of the artifact version.

catalogItemName

String

Name of the catalog item.

catalogName

String

Name of the catalog containing the catalog item.

ciBuildName

String

The name of ciBuild to associate with a tag link.

ciJobDetailName

String

The name of CIJobDetail that contains the CI Build.

componentName

String

The name of the component

entityId

String

Id of the entity to associate with an entity tag link.

entityType

String

The entity type to associate with an entity tag link.

environmentName

String

The name of the environment

environmentTemplateName

String

The name of the environment template

flowRuntimeId

String

Id of the flowRuntime to associate with a tag link.

gateType

String

The type of the gate.

jobId

String

Id of the job to associate with a tag link.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure

processName

String

The name of the process

processStepName

String

The name of the process step

projectName

String

The name of the project

releaseName

String

The name of the release

resourceName

String

The name of the resource

resourcePoolName

String

The name of the resourcePool

resourceTemplateName

String

The name of the resource template

stageName

String

The name of the stage

stepName

String

The name of the procedure step

tags

String array

List of tags to add to the entity.

taskName

String

The name of the task

triggerName

String

The name of the trigger

workItemId

String

Id for the work item to associate with a tag link

workflowDefinitionName

String

The name of the workflow definition

workflowId

String

Id of the workflow to associate with a tag link.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.tagObject(
                /* optional arguments */)

untagObject

Remove a tag from an object.

Arguments

Argument NameTypeDescription

applicationName

String

The name of the application

artifactName

String

The name of the artifact

artifactVersionName

String

The name of the artifact version.

catalogItemName

String

Name of the catalog item.

catalogName

String

Name of the catalog containing the catalog item.

ciBuildName

String

The name of ciBuild to associate with a tag link.

ciJobDetailName

String

The name of CIJobDetail that contains the CI Build.

componentName

String

The name of the component

entityId

String

Id of the entity to associate with an entity tag link.

entityType

String

The entity type to associate with an entity tag link.

environmentName

String

The name of the environment

environmentTemplateName

String

The name of the environment template

flowRuntimeId

String

Id of the flowRuntime to associate with a tag link.

gateType

String

The type of the gate.

jobId

String

Id of the job to associate with a tag link.

pipelineName

String

The name of the pipeline

procedureName

String

The name of the procedure

processName

String

The name of the process

processStepName

String

The name of the process step

projectName

String

The name of the project

releaseName

String

The name of the release

resourceName

String

The name of the resource

resourcePoolName

String

The name of the resourcePool

resourceTemplateName

String

The name of the resource template

stageName

String

The name of the stage

stepName

String

The name of the procedure step

tags

String array

List of tags to add to the entity.

taskName

String

The name of the task

triggerName

String

The name of the trigger

workItemId

String

Id for the work item to associate with a tag link

workflowDefinitionName

String

The name of the workflow definition

workflowId

String

Id of the workflow to associate with a tag link.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.untagObject(
                /* optional arguments */)
statedefinition
task