Using the Perl API
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
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuserutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

ServiceDependency

2 minute readReference

createServiceDependency

[DEPRECATED] This API is deprecated. Adds service dependency to the specified service.

Arguments

Argument Name Type Description

projectName

String

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

serviceName

String

The name of the service (Required)

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentServiceName

String

The name of service which this application depends on.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2006-05-15).

serviceDependencyName

String

The name of service dependency. If not specified, a system generated guid is used.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteServiceDependency

[DEPRECATED] This API is deprecated. Deletes service dependency

Arguments

Argument Name Type Description

projectName

String

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

serviceName

String

The name of the service (Required)

serviceDependencyName

String

The name of service dependency. If not specified, a system generated guid is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentServiceName

String

The name of service which this application depends on.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyServiceDependency

[DEPRECATED] This API is deprecated. Modifies service dependency for the specified service.

Arguments

Argument Name Type Description

projectName

String

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

serviceName

String

The name of the service (Required)

serviceDependencyName

String

The name of service dependency. If not specified, a system generated guid is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentServiceName

String

The name of service which this application depends on.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2006-05-15).

newName

String

New name for an existing object that is being renamed.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyServiceDependency(
                projectName: 'test-projectName',
                serviceName: 'test-serviceName',
                /* optional arguments */)
serviceclustermapping
servicemapdetail