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

Tier map

4 minute readReference

createEnvironmentTemplateTierMapping

Creates a new environment template tier mapping for an environment template tier map.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationTierName

String

Name of the application tier.

environmentProjectName

String

The name of the environment template’s project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateTierMapName

String

The name of the environment template tier map.

environmentTemplateTierMappingName

String

The name of the environment template tier mapping. If not specified the operation will assume a UUID string.

environmentTemplateTierName

String

Name of the environment template tier.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->createEnvironmentTemplateTierMapping(<projectName>, <applicationName>, {<optionals>});
▼

ectool

ectool createEnvironmentTemplateTierMapping projectName applicationName [optionals]
▼

createTierMap

Creates a tier map for an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentName

String

(Required) The name of the environment.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

tierMapName

String

The name of the tier map. If not specified the operation will assume a hyphenated application and environment name.

tierMappings

Map

The list of mappings between the application tiers and the environment tiers.

Positional arguments

projectName, applicationName, environmentProjectName, environmentName

Usage

ec-perl

$cmdr->createTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>, {<optionals>});
▼

ectool

ectool createTierMap projectName applicationName environmentProjectName environmentName [optionals]
▼

createTierMapping

Creates a tier mapping in the specified tier map for the application.

Arguments

Argument Name Type Description

projectName

String

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

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

The name of the application.

applicationTierName

String

Name of the application tier.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment’s project name.

environmentTierName

String

Name of the environment tier.

resourceExpression

String

Resource expression to pick up resources from the environment tier.

tierMapName

String

The name of the tier map.

tierMappingName

String

The name of the tierMapping.

Positional arguments

projectName

Usage

ec-perl

$cmdr->createTierMapping(<projectName>, {<optionals>});
▼

ectool

ectool createTierMapping projectName [optionals]
▼

deleteTierMap

Deletes a tier map from an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentName

String

(Required) The name of the environment.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

Positional arguments

projectName, applicationName, environmentProjectName, environmentName

Usage

ec-perl

$cmdr->deleteTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>, {<optionals>});
▼

ectool

ectool deleteTierMap projectName applicationName environmentProjectName environmentName [optionals]
▼

deleteTierMapping

Deletes a tier mapping from a tier map.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentName

String

(Required) The name of the environment.

applicationTierName

String

(Required) The name of the application tier.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

Positional arguments

projectName, applicationName, environmentProjectName, environmentName, applicationTierName

Usage

ec-perl

$cmdr->deleteTierMapping(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>, <applicationTierName>, {<optionals>});
▼

ectool

ectool deleteTierMapping projectName applicationName environmentProjectName environmentName applicationTierName [optionals]
▼

getTierMaps

Retrieves all tier maps that are used by an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

orderByEnvironmentUsage

Boolean

True to return most recently used environment.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->getTierMaps(<projectName>, <applicationName>, {<optionals>});
▼

ectool

ectool getTierMaps projectName applicationName [optionals]
▼

modifyEnvironmentTemplateTierMapping

Modifies an existing environment template tier mapping.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationTierName

String

Name of the application tier.

environmentProjectName

String

The name of the environment template’s project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateTierMapName

String

The name of the environment template tier map.

environmentTemplateTierMappingName

String

The name of the environment template tier mapping. If not specified the operation will assume a UUID string.

environmentTemplateTierName

String

Name of the environment template tier.

newName

String

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

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->modifyEnvironmentTemplateTierMapping(<projectName>, <applicationName>, {<optionals>});
▼

ectool

ectool modifyEnvironmentTemplateTierMapping projectName applicationName [optionals]
▼

modifyTierMap

Modifies an existing tier map.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentName

String

(Required) The name of the environment.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

tierMapName

String

The name of the tier map. If not specified the operation will assume a hyphenated application and environment name.

tierMappings

Map

The list of mappings between the application tiers and the environment tiers.

Positional arguments

projectName, applicationName, environmentProjectName, environmentName

Usage

ec-perl

$cmdr->modifyTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>, {<optionals>});
▼

ectool

ectool modifyTierMap projectName applicationName environmentProjectName environmentName [optionals]
▼

modifyTierMapping

Modifies a tier mapping in the specified tier map for the application.

Arguments

Argument Name Type Description

projectName

String

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

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

The name of the application.

applicationTierName

String

Name of the application tier.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment’s project name.

environmentTierName

String

Name of the environment tier.

newName

String

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

resourceExpression

String

Resource expression to pick up resources from the environment tier.

tierMapName

String

The name of the tier map.

tierMappingName

String

The name of the tierMapping.

Positional arguments

projectName

Usage

ec-perl

$cmdr->modifyTierMapping(<projectName>, {<optionals>});
▼

ectool

ectool modifyTierMapping projectName [optionals]
▼
Snapshots
Trigger