Using the Perl API
Perl API reference
IntroductionACL 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 managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

ServiceClusterMapping

6 minute readReference

createServiceClusterMapping

[DEPRECATED] This API is deprecated. Creates a new mapping between an application/project service and environment cluster.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

actualParameters

ActualParameter array

Actual parameters specific to plugin procedure associated with the application service

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

defaultCapacity

String

The default service capacity

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

maxCapacity

String

The max service capacity

minCapacity

String

The min service capacity

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

volume

String

Volume json of the service

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteServiceClusterMapping

[DEPRECATED] This API is deprecated. Deletes an service cluster mapping.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getApplicationServiceMappings

[DEPRECATED] This API is deprecated. Retrieve all application service mappings in a tierMap.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

applicationEntityRevisionId

String

Revisionid of the versioned object

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

includeDetails

Boolean

True to include details (default is false)

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getServiceClusterMapping

[DEPRECATED] This API is deprecated. Retrieve a service cluster mapping.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the service cluster mapping.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

includeDetails

Boolean

True to include details (default is false)

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getServiceClusterMappings

[DEPRECATED] This API is deprecated. Retrieve all service cluster mappings.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

applicationEntityRevisionId

String

Revisionid of the versioned object

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

includeDetails

Boolean

True to include details (default is false)

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyServiceClusterMapping

[DEPRECATED] This API is deprecated. Modifies an existing service cluster mapping.

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the service cluster mapping.

actualParameters

ActualParameter array

Actual parameters specific to plugin procedure associated with the application service

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clearActualParameters

Boolean

True if we should remove all actual parameters.

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

defaultCapacity

String

The default service capacity

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

maxCapacity

String

The max service capacity

minCapacity

String

The min service capacity

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

volume

String

Volume json of the service

Usage

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


ElectricFlow ef = new ElectricFlow()

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

validateServiceClusterMapping

[DEPRECATED] This API is deprecated. Validate service cluster mapping operation

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 which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster.

clusterProjectName

String

The name of the project which contains the cluster.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.validateServiceClusterMapping(
                projectName: 'test-projectName',
                /* optional arguments */)
service
servicedependency