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

ResourceTemplate

3 minute readReference

createResourceTemplate

Creates a resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates. (Required)

cfgMgrParameters

CfgMgrParameter array

Configuration manager plugin parameters.

cfgMgrPluginKey

String

Configuration manager plugin key.

cfgMgrProcedure

String

Configuration manager plugin method name.

cfgMgrProjectName

String

Configuration manager plugin project name.

cloudProviderParameters

array

Cloud provider plugin parameters.

cloudProviderPluginKey

String

Cloud provider plugin key.

cloudProviderProcedure

String

Cloud provider plugin method name.

cloudProviderProjectName

String

Cloud provider plugin project name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteResourceTemplate

Deletes a resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteResourceTemplate(
                projectName: 'test-projectName',
                resourceTemplateName: 'test-resourceTemplateName')

getResourceTemplate

Retrieves the specified resource template.

Arguments

Argument Name Type Description

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates. (Required)

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getResourceTemplate(
                resourceTemplateName: 'test-resourceTemplateName',
                projectName: 'test-projectName')

getResourceTemplates

Retrieves all the resource templates.

Arguments

Argument Name Type Description

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getResourceTemplates(
                projectName: 'test-projectName')

getResourceTemplatesInEnvironmentTemplateTier

Retrieves all resource templates in the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

Name for the environment template tier; must be unique among all tiers for the environment template. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getResourceTemplatesInEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName')

modifyResourceTemplate

Modifies the specified resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates. (Required)

cfgMgrParameters

CfgMgrParameter array

Configuration manager plugin parameters.

cfgMgrPluginKey

String

Configuration manager plugin key.

cfgMgrProcedure

String

Configuration manager plugin method name.

cfgMgrProjectName

String

Configuration manager plugin project name.

cloudProviderParameters

array

Cloud provider plugin parameters.

cloudProviderPluginKey

String

Cloud provider plugin key.

cloudProviderProcedure

String

Cloud provider plugin method name.

cloudProviderProjectName

String

Cloud provider plugin project name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

The new name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeResourceTemplateFromEnvironmentTemplateTier

Removes a resource template from the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

Name for the environment template tier; must be unique among all tiers for the environment template. (Required)

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates. (Required)

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeResourceTemplateFromEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName',
                resourceTemplateName: 'test-resourceTemplateName'
                /* optional arguments */)
resourcepool
resourceusage