Flow API guide
IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
Perl API Commands
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory 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
Groovy API guide
IntroductionExamples
Groovy API commands
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

ResourceTemplate commands

3 minute readReference

createResourceTemplate

Creates a new resource template.

Arguments

Argument NameTypeDescription

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

cloudProviderParameter 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 Flow.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteResourceTemplate

Delete a resource template.

Arguments

Argument NameTypeDescription

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getResourceTemplate

Retrieve a resource template by name.

Arguments

Argument NameTypeDescription

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getResourceTemplates

Retrieve all resource templates.

Arguments

Argument NameTypeDescription

projectName

String

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

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getResourceTemplatesInEnvironmentTemplateTier

Retrieve all resource templates in environment template tier

Arguments

Argument NameTypeDescription

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

modifyResourceTemplate

Modifies an existing resourceTemplate.

Arguments

Argument NameTypeDescription

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

cloudProviderParameter 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 Flow.

newName

String

New name for an existing object that is being renamed.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

removeResourceTemplateFromEnvironmentTemplateTier

Removes the given resource template from the given environment template tier.

Arguments

Argument NameTypeDescription

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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