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

DeployerApplication

3 minute readReference

createDeployerApplication

Adds a deployer application to a release.

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)

releaseName

String

The name of the release.

afterLastRetry

String

Specify continue or stop pipeline execution after last unsuccessful retry or a task.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

enforceDependencies

Boolean

Enforce dependencies flag to be used during runProcess for the application.

errorHandling

String

Specifies error handling for the deployer application.

orderIndex

Integer

Specifies the application deployment order (starts from 1).

processName

String

The name of the application process.

retryApprovers

String array

A list of retry approvers who receive the notification.

retryCount

String

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

String

If the retry is auto, specify the number of seconds to wait until the next retry should occur.

retryNotificationTemplate

String

Email retry notification template for application.

retryType

String

Type of retry when process step or task fails. Is one of auto or manual.

smartDeploy

Boolean

Smart deploy flag to be used during runProcess for the application.

snapshotName

String

The name of the snapshot.

stageArtifacts

Boolean

Stage artifacts for the application process.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getDeployerApplication

Retrieves the application used in the release by name.

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)

releaseName

String

The name of the release.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getDeployerApplications

Retrieves all the applications in a release.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

The name of the release.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeployerApplications(
                projectName: 'test-projectName', )
▼

modifyDeployerApplication

Modifies the deployer application associated with a release.

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)

releaseName

String

The name of the release.

afterLastRetry

String

Specify continue or stop pipeline execution after last unsuccessful retry or a task.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

enforceDependencies

Boolean

Enforce dependencies flag to be used during runProcess for the application.

errorHandling

String

Specifies error handling for the deployer application.

orderIndex

Integer

Specifies the application deployment order (starts from 1).

processName

String

The name of the application process.

retryApprovers

String array

A list of retry approvers who receive the notification.

retryCount

String

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

String

If the retry is auto, specify the number of seconds to wait until the next retry should occur.

retryNotificationTemplate

String

Email retry notification template for application.

retryType

String

Type of retry when process step or task fails. Is one of auto or manual.

smartDeploy

Boolean

Smart deploy flag to be used during runProcess for the application.

snapshotName

String

The name of the snapshot.

stageArtifacts

Boolean

Stage artifacts for the application process.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeDeployerApplication

Removes a deployer application for a release.

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)

releaseName

String

The name of the release.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeDeployerApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼
dataretentionpolicy
deployerconfiguration