createTag
Creates a new tag for an object.
You must specify the tagName
.
Arguments | Descriptions |
---|---|
tagName | Name of the tag. Argument Type: String |
colorCode | (Optional) Hexadecimal value of the color to be used with an entity. Argument Type: String |
description | (Optional) Comment text describing this object. CloudBees CD/RO ignores this text. Argument Type: String |
deleteTag
Deletes an existing object tag.
You must specify the tagName
.
Arguments | Descriptions |
---|---|
tagName | Name of the tag. Argument Type: String |
getTag
Retrieves an existing object tag.
You must specify the tagName
.
Arguments | Descriptions |
---|---|
tagName | Name of the tag. Argument Type: String |
getTags
Get tags based on requested criteria.
Arguments | Descriptions |
---|---|
applicationName | (Optional) Name of the application. Argument Type: String |
artifactName | (Optional) Name of the artifact. Argument Type: String |
artifactVersionName | (Optional) Name of the artifact version. Argument Type: String |
componentName | (Optional) Name of the component. Argument Type: String |
entityId | (Optional) ID of the entity to associate with an entity tag link. Argument Type: UUID |
entityType | (Optional) Entity type to associate with an entity tag link. Argument Type: String |
environmentName | (Optional) Name of the environment. Argument Type: String |
environmentTemplateName | (Optional) Name of the environment template. Argument Type: String |
flowRuntimeId | (Optional) ID of the flowRuntime to associate with a tag link. Argument Type: UUID |
gateType <POST|PRE> | (Optional) Type of the gate. Argument Type: String |
jobId | (Optional) ID of the job to associate with a tag link. Argument Type: UUID |
pipelineName | (Optional) Name of the pipeline. Argument Type: String |
procedureName | (Optional) Name of the procedure. Argument Type: String |
processName | (Optional) Name of the process. Argument Type: String |
processStepName | (Optional) Name of the process step. Argument Type: String |
projectName | (Optional) Name of the project. Argument Type: String |
releaseName | (Optional) Name of the release. Argument Type: String |
resourceName | (Optional) Name of the resource. Argument Type: String |
resourceTemplateName | (Optional) Name of the resource template. Argument Type: String |
serviceName | (Optional) Name of the service. Argument Type: String |
stageName | (Optional) Name of the stage. Argument Type: String |
stepName | (Optional) Name of the procedure step. Argument Type: String |
taskName | (Optional) Name of the task. Argument Type: String |
workflowDefinitionName | (Optional) Name of the workflow definition. Argument Type: String |
workflowId | (Optional) ID of the workflow to associate with a tag link. Argument Type: UUID |
workItemId | (Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link. Argument Type: UUID |
tagObject
Adds a tag to an object.
You must specify the tagName
.
Arguments | Descriptions |
---|---|
tagName | Name of the tag. Argument Type: String |
applicationName | (Optional) Name of the application. Argument Type: String |
artifactName | (Optional) Name of the artifact. Argument Type: String |
artifactVersionName | (Optional) Name of the artifact version. Argument Type: String |
componentName | (Optional) Name of the component. Argument Type: String |
entityId | (Optional) ID of the entity to associate with an entity tag link. Argument Type: UUID |
entityType | (Optional) Entity type to associate with an entity tag link. Argument Type: String |
environmentName | (Optional) Name of the environment. Argument Type: String |
environmentTemplateName | (Optional) Name of the environment template. Argument Type: String |
flowRuntimeId | (Optional) ID of the flowRuntime to associate with a tag link. Argument Type: UUID |
gateType <POST|PRE> | (Optional) Type of the gate. Argument Type: String |
jobId | (Optional) ID of the job to associate with a tag link. Argument Type: UUID |
pipelineName | (Optional) Name of the pipeline. Argument Type: String |
procedureName | (Optional) Name of the procedure. Argument Type: String |
processName | (Optional) Name of the process. Argument Type: String |
processStepName | (Optional) Name of the process step. Argument Type: String |
projectName | (Optional) Name of the project. Argument Type: String |
releaseName | (Optional) Name of the release. Argument Type: String |
resourceName | (Optional) Name of the resource. Argument Type: String |
resourceTemplateName | (Optional) Name of the resource template. Argument Type: String |
serviceName | (Optional) Name of the service. Argument Type: String |
stageName | (Optional) Name of the stage. Argument Type: String |
stepName | (Optional) Name of the procedure step. Argument Type: String |
tags tag1 tag2 … | (Optional) List of tags to add to the entity. Argument Type: String |
taskName | (Optional) Name of the task. Argument Type: String |
workflowDefinitionName | (Optional) Name of the workflow definition. Argument Type: String |
workflowId | (Optional) ID of the workflow to associate with a tag link. Argument Type: UUID |
workItemId | (Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link. Argument Type: UUID |
untagObject
Removes a tag from an object.
You must specify the tagName
.
Arguments | Descriptions |
---|---|
tagName | Name of the tag. Argument Type: String |
applicationName | (Optional) Name of the application. Argument Type: String |
artifactName | (Optional) Name of the artifact. Argument Type: String |
artifactVersionName | (Optional) Name of the artifact version. Argument Type: String |
componentName | (Optional) Name of the component. Argument Type: String |
entityId | (Optional) ID of the entity to associate with an entity tag link. Argument Type: UUID |
entityType | (Optional) Entity type to associate with an entity tag link. Argument Type: String |
environmentName | (Optional) Name of the environment. Argument Type: String |
environmentTemplateName | (Optional) Name of the environment template. Argument Type: String |
flowRuntimeId | (Optional) ID of the flowRuntime to associate with a tag link. Argument Type: UUID |
gateType <POST|PRE> | (Optional) Type of the gate. Argument Type: String |
jobId | (Optional) ID of the job to associate with a tag link. Argument Type: UUID |
pipelineName | (Optional) Name of the pipeline. Argument Type: String |
procedureName | (Optional) Name of the procedure. Argument Type: String |
processName | (Optional) Name of the process. Argument Type: String |
processStepName | (Optional) Name of the process step. Argument Type: String |
projectName | (Optional) Name of the project. Argument Type: String |
releaseName | (Optional) Name of the release. Argument Type: String |
resourceName | (Optional) Name of the resource. Argument Type: String |
resourceTemplateName | (Optional) Name of the resource template. Argument Type: String |
serviceName | (Optional) Name of the service. Argument Type: String |
stageName | (Optional) Name of the stage. Argument Type: String |
stepName | (Optional) Name of the procedure step. Argument Type: String |
tags tag1 tag2 … | (Optional) List of tags to add to the entity. Argument Type: String |
taskName | (Optional) Name of the task. Argument Type: String |
workflowDefinitionName | (Optional) Name of the workflow definition. Argument Type: String |
workItemId | (Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link. Argument Type: UUID |