Using the Perl API
IntroductionAccess tokensACL 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 managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

FormalParameter

12 minute readReference

attachParameter

Attach a formal parameter to a step.

Arguments

Argument Name Type Description

projectName

String

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

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

procedureName

String

The name of the procedure.

stepName

String

The name of the step in the procedure.

applicationName

String

The name of the application

componentApplicationName

String

The name of the component in the application.

componentName

String

The name of the component

gateType

String

The type of the gate.

microserviceApplicationName

String

The name of the microservice application

microserviceName

String

The name of the microservice

pipelineName

String

The name of the pipeline

processName

String

The name of the process.

processStepName

String

The name of the step in the process.

releaseName

String

The name of the release, if attaching a credential to a release pipeline.

stageName

String

Name of the stage to which this task belongs to.

stateDefinitionName

String

The name of the workflow state definition, if attaching a parameter to a state definition.

taskName

String

The name of the task.

workflowDefinitionName

String

The name of the workflow definition, if attaching a parameter to a workflow state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

createFormalParameter

Create a new formal parameter.

Arguments

Argument Name Type Description

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

projectName

String

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

reportName

String

The name of the report, if the formal parameter is on a report.

applicationName

String

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

String

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

String

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

String

The name of the catalog to which the catalog item belongs to.

checkedValue

String

Parameter value when the checkbox used to render the parameter is checked. Applicable only for 'checkbox' type.

componentName

String

The name of the component, if the formal parameter is on a component process.

dashboardName

String

The name of the dashboard, if the formal parameter is on a dashboard.

defaultValue

String

If no value is provided for the parameter when the procedure is invoked, this value will be used.

dependsOn

String

Comma-separated list of formal parameters that this parameter depends on. Use with cascading drop-down ('select') parameters to declare dependency on one or more parameters.

description

String

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

expansionDeferred

Boolean

True means expansion for this parameter should be deferred: the parameter value will not be expanded when the procedure call is expanded, but can be expanded from a command step instead.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

gateType

String

The type of the gate which contains the task, if the formal parameter is belongs to a task.

label

String

Specifies the display label.

microserviceName

String

The name of the microservice.

options

Option array

Ordered list of options.

optionsDsl

String

Dsl for populating drop-down options for 'select' formal parameter type.

optionsFromPropertySheet

String

Path to the property sheet containing the options.

orderIndex

Integer

Specifies the display order index (starts from 1).

pipelineName

String

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the formal parameter is on a process.

processStepName

String

The name of the process step, if the formal parameter is on a process step.

projectFormalParameterName

String

Used when rendering the formal parameter to identify the formal parameter to use in order to get the owning project name. Applicable only for 'release', 'pipeline', 'application', 'service' or 'environment' parameter type.

propertyReference

String

Property or property sheet to use for displaying options.

propertyReferenceType

String

Whether the 'propertyReference' value is a property sheet (default) or a property. For property sheet, nested property names are used as options while for property, the property value is used as an option.

releaseName

String

The name of the release, if the formal parameter is on a release-scoped pipeline.

renderCondition

String

Condition for rendering the formal parameter.

required

Boolean

True means this parameter is required: the procedure will not execute unless a value is given for the parameter.

simpleList

String

Pipe-separated list of options, e.g., option1|option2|option3.

stageName

String

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

String

The name of the state definition.

stateName

String

The name of a workflow state.

taskName

String

The name of the task, if the formal parameter is belongs to a task.

type

String

The type of a formal parameter.

uncheckedValue

String

Parameter value when the checkbox used to render the parameter is unchecked. Applicable only for 'checkbox' type.

updateFormXml

Boolean

Whether the parameter form XML stored in the procedure property 'ec_parameterForm' should also be updated.

validationDsl

String

Dsl for validating the formal parameter.

workflowDefinitionName

String

The name of the workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createFormalParameter(
                formalParameterName: 'test-formalParameterName'
                /* optional arguments */)
▼

deleteFormalParameter

Delete a formal parameter.

Arguments

Argument Name Type Description

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

projectName

String

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

reportName

String

The name of the report, if the formal parameter is on a report.

applicationName

String

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

String

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

String

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

String

The name of the catalog to which the catalog item belongs to.

componentName

String

The name of the component, if the formal parameter is on a component process.

dashboardName

String

The name of the dashboard, if the formal parameter is on a dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

gateType

String

The type of the gate which contains the task, if the formal parameter is belongs to a task.

microserviceName

String

The name of the microservice.

pipelineName

String

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the formal parameter is on a process.

processStepName

String

The name of the process step, if the formal parameter is on a process step.

releaseName

String

The name of the release, if the formal parameter is on a release-scoped pipeline.

stageName

String

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

String

The name of the state definition.

stateName

String

The name of a workflow state.

taskName

String

The name of the task, if the formal parameter is belongs to a task.

updateFormXml

Boolean

Whether the parameter form XML stored in the procedure property 'ec_parameterForm' should also be updated.

workflowDefinitionName

String

The name of the workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteFormalParameter(
                formalParameterName: 'test-formalParameterName'
                /* optional arguments */)
▼

detachParameter

Detach a formal parameter from a step.

Arguments

Argument Name Type Description

projectName

String

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

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

procedureName

String

The name of the procedure.

stepName

String

The name of the step in the procedure.

applicationName

String

The name of the application

componentApplicationName

String

The name of the component in the application.

componentName

String

The name of the component

gateType

String

The type of the gate.

microserviceApplicationName

String

The name of the microservice application

microserviceName

String

The name of the microservice

pipelineName

String

The name of the pipeline

processName

String

The name of the process.

processStepName

String

The name of the step in the process.

releaseName

String

The name of the release, if attaching a credential to a release pipeline.

stageName

String

Name of the stage to which this task belongs to.

stateDefinitionName

String

The name of the workflow state definition, if attaching a parameter to a state definition.

taskName

String

The name of the task.

workflowDefinitionName

String

The name of the workflow definition, if attaching a parameter to a workflow state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getFormalParameter

Get a formal parameter by name.

Arguments

Argument Name Type Description

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

projectName

String

Name for the project; must be unique among all projects.

reportName

String

The name of the report, if the formal parameter is on a report.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

String

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

String

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

String

The name of the catalog to which the catalog item belongs to.

componentName

String

The name of the component, if the formal parameter is on a component process.

dashboardName

String

The name of the dashboard, if the formal parameter is on a dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowRuntimeStateId

String

The id of the flow runtime state.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

gateType

String

The type of the gate which contains the task, if the formal parameter is belongs to a task.

includeDetails

Boolean

True to include details such as corresponding properties in the ec_customEditorData property sheet (default is false)

microserviceName

String

The name of the microservice.

pipelineName

String

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the formal parameter is on a process.

processStepName

String

The name of the process step, if the formal parameter is on a process step.

releaseName

String

The name of the release, if the formal parameter is on a release-scoped pipeline.

stageName

String

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

String

The name of the state definition.

stateName

String

The name of a workflow state.

taskName

String

The name of the task, if the formal parameter is belongs to a task.

workflowDefinitionName

String

The name of the workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getFormalParameter(
                formalParameterName: 'test-formalParameterName'
                /* optional arguments */)
▼

getFormalParameters

Get all formal parameters from procedure, schedule, step, or state definition.

Arguments

Argument Name Type Description

projectName

String

Name for the project; must be unique among all projects.

reportName

String

The name of the report, if the formal parameter is on a report.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

String

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

String

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

String

The name of the catalog to which the catalog item belongs to.

componentName

String

The name of the component, if the formal parameter is on a component process.

dashboardName

String

The name of the dashboard, if the formal parameter is on a dashboard.

flowName

String

The name of the flow to which the flow state belongs to.

flowRuntimeStateId

String

The id of the flow runtime state.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

gateType

String

The type of the gate which contains the task, if the formal parameter is belongs to a task.

includeDetails

Boolean

True to include details such as corresponding properties in the ec_customEditorData property sheet (default is false)

microserviceName

String

The name of the microservice.

pipelineName

String

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

String

The name of a procedure.

processName

String

The name of the process, if the formal parameter is on a process.

processStepName

String

The name of the process step, if the formal parameter is on a process step.

releaseName

String

The name of the release, if the formal parameter is on a release-scoped pipeline.

scheduleName

String

The name of a schedule.

stageName

String

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

String

The name of the state definition.

stateName

String

The name of a workflow state.

stepName

String

The name of a procedure step.

taskName

String

The name of the task, if the formal parameter is belongs to a task.

workflowDefinitionName

String

The name of the workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getFormalParameters(
                /* optional arguments */)
▼

modifyFormalParameter

Modify an existing formal parameter.

Arguments

Argument Name Type Description

formalParameterName

String

Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required)

projectName

String

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

reportName

String

The name of the report, if the formal parameter is on a report.

applicationName

String

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

String

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

String

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

String

The name of the catalog to which the catalog item belongs to.

checkedValue

String

Parameter value when the checkbox used to render the parameter is checked. Applicable only for 'checkbox' type.

clearOptions

Boolean

Whether or not to clear options for formal parameter.

componentName

String

The name of the component, if the formal parameter is on a component process.

dashboardName

String

The name of the dashboard, if the formal parameter is on a dashboard.

defaultValue

String

If no value is provided for the parameter when the procedure is invoked, this value will be used.

dependsOn

String

Comma-separated list of formal parameters that this parameter depends on. Use with cascading drop-down ('select') parameters to declare dependency on one or more parameters.

description

String

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

expansionDeferred

Boolean

True means expansion for this parameter should be deferred: the parameter value will not be expanded when the procedure call is expanded, but can be expanded from a command step instead.

flowName

String

The name of the flow to which the flow state belongs to.

flowStateName

String

The name of the flow state, if the formal parameter is on a flow state.

gateType

String

The type of the gate which contains the task, if the formal parameter is belongs to a task.

label

String

Specifies the display label.

microserviceName

String

The name of the microservice.

newName

String

New name for an existing object that is being renamed.

options

Option array

Ordered list of options.

optionsDsl

String

Dsl for populating drop-down options for 'select' formal parameter type.

optionsFromPropertySheet

String

Path to the property sheet containing the options.

orderIndex

Integer

Specifies the display order index (starts from 1).

pipelineName

String

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

String

The name of the procedure.

processName

String

The name of the process, if the formal parameter is on a process.

processStepName

String

The name of the process step, if the formal parameter is on a process step.

projectFormalParameterName

String

Used when rendering the formal parameter to identify the formal parameter to use in order to get the owning project name. Applicable only for 'release', 'pipeline', 'application', 'service' or 'environment' parameter type.

propertyReference

String

Property or property sheet to use for displaying options.

propertyReferenceType

String

Whether the 'propertyReference' value is a property sheet (default) or a property. For property sheet, nested property names are used as options while for property, the property value is used as an option.

releaseName

String

The name of the release, if the formal parameter is on a release-scoped pipeline.

renderCondition

String

Condition for rendering the formal parameter.

required

Boolean

True means this parameter is required: the procedure will not execute unless a value is given for the parameter.

simpleList

String

Pipe-separated list of options, e.g., option1|option2|option3.

stageName

String

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

String

The name of the state definition.

stateName

String

The name of a workflow state.

taskName

String

The name of the task, if the formal parameter is belongs to a task.

type

String

The type of a formal parameter.

uncheckedValue

String

Parameter value when the checkbox used to render the parameter is unchecked. Applicable only for 'checkbox' type.

updateFormXml

Boolean

Whether the parameter form XML stored in the procedure property 'ec_parameterForm' should also be updated.

validationDsl

String

Dsl for validating the formal parameter.

workflowDefinitionName

String

The name of the workflow definition.

workflowName

String

The name of a workflow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyFormalParameter(
                formalParameterName: 'test-formalParameterName'
                /* optional arguments */)
▼
formaloutputparameter
gate