Index
modifyEnvTemplTierResourceTemplMapping
getPluginCatalog
getResourceUsage
getRetrievedArtifacts
runDiscovery
getServerSettings
getServerSettingsCategories
revokeToken
getWorkItems
ActionParameterActualParameterAdditionalFilterAttributeDataTypeAttributePathCfgMgrParameterCloudProviderParameterColorComponentVersionCredentialCredentialReferenceParameterDefinitionParameterDefinitionSourceParameterDeployParameterDestinationMappingExportParameterFieldFilterFormParameterHookActualParameterHookParameterImportParameterLinkParameterOptionPipelineParameterPluginParameterProvisionParameterReleaseFlowRuntimeMappingResourcePhaseMappingResourcePoolPhaseMappingRollbackParameterSelectSortTierMappingTierResourceCountVisualizationProperty

getTags

On this page
Back to index

Summary

Retrieves tags based on requested criteria.
applicationName
Stringoptional
The name of the application.
artifactName
Stringoptional
The name of the artifact.
artifactVersionName
Stringoptional
The name of the artifact version.
catalogItemName
Stringoptional
Name of the catalog item.
catalogName
Stringoptional
Name of the catalog containing the catalog item.
ciBuildName
Stringoptional
The name of ciBuild to associate with a tag link.
ciJobDetailName
Stringoptional
The name of CIJobDetail that contains the CI Build.
componentName
Stringoptional
The name of the component.
entityId
Stringoptional
ID of the entity to associate with an entity tag link.
entityType
Stringoptional
The entity type to associate with an entity tag link.
environmentName
Stringoptional
The name of the environment.
environmentTemplateName
Stringoptional
The name of the environment template.
flowRuntimeId
Stringoptional
ID of the flowRuntime to associate with a tag link.
gateType
Stringoptional
The type of the gate.
Possible values: "POST", "PRE"
includeApplicationComponents
Booleanoptional
Flag to indicate if the application component needs to be included in the response.
jobId
Stringoptional
ID of the job to associate with a tag link.
pipelineName
Stringoptional
The name of the pipeline.
procedureName
Stringoptional
The name of the procedure.
processName
Stringoptional
The name of the process.
processStepName
Stringoptional
The name of the process step.
projectName
Stringoptional
The name of the project.
releaseName
Stringoptional
The name of the release.
resourceName
Stringoptional
The name of the resource.
resourcePoolName
Stringoptional
The name of the resourcePool.
resourceTemplateName
Stringoptional
The name of the resource template.
stageName
Stringoptional
The name of the stage.
stepName
Stringoptional
The name of the procedure step.
taskName
Stringoptional
The name of the task.
triggerName
Stringoptional
The name of the trigger.
workItemId
Stringoptional
ID for the work item to associate with a tag link.
workflowDefinitionName
Stringoptional
The name of the workflow definition.
workflowId
Stringoptional
ID of the workflow to associate with a tag link.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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