Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementGet application environment inventoryInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

TierMap

2 minute readReference

createTierMap

Creates a new 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

Revisionid 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

Revisionid 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

Retrieve all tier maps that are used by the given 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

Revisionid 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

Revisionid 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