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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

TierMap

2 minute readReference

createTierMap

Creates a tier map for an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.(Required)

environmentName

String

The name of the environment.(Required)

environmentProjectName

String

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

applicationEntityRevisionId

String

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

TierMapping array

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createTierMap(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                environmentName: 'test-environmentName',
                environmentProjectName: 'test-environmentProjectName'
                /* optional arguments */)

deleteTierMap

Deletes a tier map from an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.(Required)

environmentName

String

The name of the environment.(Required)

environmentProjectName

String

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

applicationEntityRevisionId

String

The revision ID of the versioned object.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteTierMap(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                environmentName: 'test-environmentName',
                environmentProjectName: 'test-environmentProjectName'
                /* optional arguments */)

getTierMaps

Retrieves all tier maps that are used by an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.(Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

orderByEnvironmentUsage

Boolean

True to return most recently used environment.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getTierMaps(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)

modifyTierMap

Modifies an existing tier map.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.(Required)

environmentName

String

The name of the environment.(Required)

environmentProjectName

String

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

tierMapName

String

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

applicationEntityRevisionId

String

The revision ID of the versioned object.

tierMappings

TierMapping array

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyTierMap(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                environmentName: 'test-environmentName',
                environmentProjectName: 'test-environmentProjectName'
                /* optional arguments */)
task
tiermapping