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

Object tag

4 minute readReference

createTag

Creates a new tag for an object.

Arguments

Argument Name Type Description

tagName

String

(Required) The tag name.

description

String

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

Positional arguments

tagName

Usage

ec-perl

$cmdr->createTag(<tagName>, {<optionals>});
▼

ectool

ectool createTag tagName [optionals]
▼

deleteTag

Deletes an existing object tag.

Arguments

Argument Name Type Description

tagName

String

(Required) The tag name.

Positional arguments

tagName

Usage

ec-perl

$cmdr->deleteTag(<tagName>);
▼

ectool

ectool deleteTag tagName
▼

getTag

Retrieves an existing object tag.

Arguments

Argument Name Type Description

tagName

String

(Required) The tag name.

Positional arguments

tagName

Usage

ec-perl

$cmdr->getTag(<tagName>);
▼

ectool

ectool getTag tagName
▼

getTags

Retrieves tags based on requested criteria.

Arguments

Argument Name Type Description

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

UUID

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

UUID

ID of the flowRuntime to associate with a tag link.

gateType

GateType

The type of the gate.

includeApplicationComponents

Boolean

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

jobId

UUID

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

UUID

ID for the work item to associate with a tag link.

workflowDefinitionName

String

The name of the workflow definition.

workflowId

UUID

ID of the workflow to associate with a tag link.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getTags [optionals]
▼

modifyTag

Modifies an existing tag.

Arguments

Argument Name Type Description

tagName

String

(Required) The tag name.

description

String

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

newName

String

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

Positional arguments

tagName

Usage

ec-perl

$cmdr->modifyTag(<tagName>, {<optionals>});
▼

ectool

ectool modifyTag tagName [optionals]
▼

tagObject

Adds a tag to an object.

Arguments

Argument Name Type Description

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

UUID

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

UUID

ID of the flowRuntime to associate with a tag link.

gateType

GateType

The type of the gate.

jobId

UUID

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

Collection

List of tags to add to the entity.

taskName

String

The name of the task.

triggerName

String

The name of the trigger.

workItemId

UUID

ID for the work item to associate with a tag link.

workflowDefinitionName

String

The name of the workflow definition.

workflowId

UUID

ID of the workflow to associate with a tag link.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool tagObject [optionals]
▼

untagObject

Removes a tag from an object.

Arguments

Argument Name Type Description

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

UUID

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

UUID

ID of the flowRuntime to associate with a tag link.

gateType

GateType

The type of the gate.

jobId

UUID

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

Collection

List of tags to add to the entity.

taskName

String

The name of the task.

triggerName

String

The name of the trigger.

workItemId

UUID

ID for the work item to associate with a tag link.

workflowDefinitionName

String

The name of the workflow definition.

workflowId

UUID

ID of the workflow to associate with a tag link.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool untagObject [optionals]
▼
Object
Parameter