Roadmap to CloudBees CD/RO APIs
CloudBees CD/RO command line access
Using DSL
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
Perl API response and element glossary
Using the Groovy API
Groovy API reference
accesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuserutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Release

Reference

addSubrelease

Adds a sub-release to a given release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

subreleaseName

String

The name of the sub-release (Required)

subreleaseProject

String

The name of the sub-release project

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addSubrelease(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName',
                subreleaseName: 'test-subreleaseName'
                /* optional arguments */)

attachPipelineRun

Add a pipeline run to another release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

flowRuntimeId

String

The id of the pipeline run to attach

Usage

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


ElectricFlow ef = new ElectricFlow()

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

completeRelease

Complete release operation.

Arguments

Argument NameTypeDescription

projectName

String

The name of the project

releaseName

String

The name of the release

releaseId

String

The id of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.completeRelease(
                /* optional arguments */)

createRelease

Creates a new release for a project.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

actualParameters

ActualParameter array

The list of actual parameters.

description

String

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

disableMultipleActiveRuns

Boolean

Boolean flag showing if option to run multiple pipelines simultaneously is disabled

disablePipelineRestart

Boolean

True to disable restart release pipeline.

overrideWorkspace

Boolean

If true and workspaceName is not null, then all tasks use pipeline’s workspace

pipelineName

String

The name of the pipeline

pipelineProjectName

String

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

pipelineWorkspaceName

String

The name of the workspace used by pipeline

plannedEndDate

String

The date when this release is expected to end (for example, 2006-05-15).

plannedStartDate

String

The date when this release is expected to begin (for example, 2006-05-15).

timeZone

String

The time zone to use when interpreting times.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteRelease

Deletes a release

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteRelease(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName')

detachPipelineRun

Detaches a pipeline run to a release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

flowRuntimeId

String

The id of the pipeline run to attach

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getAttachedPipelineRuns

Get attached pipeline runs to a release.

Arguments

Argument NameTypeDescription

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.getAttachedPipelineRuns(
                projectName: 'test-projectName', )

getRelease

Retrieve a release by name.

Arguments

Argument NameTypeDescription

releaseName

String

The name of the release (Required)

projectName

String

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

releaseFlowRuntimeMappings

array

Map of releaseId and flowRuntimeId

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getReleaseInventory

Get inventory artifacts created from a release.

Arguments

Argument NameTypeDescription

releaseName

String

The name of the release (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.getReleaseInventory(
                releaseName: 'test-releaseName',
                projectName: 'test-projectName')

getReleases

Retrieve all releases.

Arguments

Argument NameTypeDescription

excludeRuntimeDetails

Boolean

True to exclude runtime details for each release.

filters

Filter array

Filters

firstResult

Integer

Result pagination: the first row to return.

maxResults

Integer

Result pagination: the number of rows to return.

projectName

String

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

releaseFlowRuntimeMappings

array

Map of releaseId and flowRuntimeId

sortKey

String

How to sort the results.

sortOrder

String

Which order to sort in

viewName

String

The name of the view.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getReleases(
                /* optional arguments */)

getSubrelease

Get a sub-release for a given release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

subreleaseName

String

The name of the sub-release (Required)

subreleaseProject

String

The name of the sub-release project

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSubrelease(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName',
                subreleaseName: 'test-subreleaseName'
                /* optional arguments */)

getSubreleases

Get sub-releases for a given release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSubreleases(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName')

modifyRelease

Modifies an existing release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

actualParameters

ActualParameter array

The list of actual parameters.

clearActualParameters

Boolean

True if the task should remove all actual parameters.

description

String

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

disableMultipleActiveRuns

Boolean

Boolean flag showing if option to run multiple pipelines simultaneously is disabled

disablePipelineRestart

Boolean

True to disable restart release pipeline.

newName

String

New name for an existing object that is being renamed.

overrideWorkspace

Boolean

If true and workspaceName is not null, then all tasks use pipeline’s workspace

pipelineName

String

The name of the pipeline

pipelineProjectName

String

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

pipelineWorkspaceName

String

The name of the workspace used by pipeline

plannedEndDate

String

The date when this release is expected to end (for example, 2006-05-15).

plannedStartDate

String

The date when this release is expected to begin (for example, 2006-05-15).

timeZone

String

The time zone to use when interpreting times.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeSubrelease

Remove a sub-release to a given release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

subreleaseName

String

The name of the sub-release (Required)

subreleaseProject

String

The name of the sub-release project

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeSubrelease(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName',
                subreleaseName: 'test-subreleaseName'
                /* optional arguments */)

startRelease

Start the specified release.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release (Required)

credentialReferenceParameters

array

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Credential array

Credentials to be used in the state.

parsedWebhookData

String

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

pipelineParameters

PipelineParameter array

The list of pipeline parameters.

priority

String

The priority of jobs launched by the release.

scheduleName

String

Name for the schedule; must be unique among all schedules for the project.

stagesToRun

String array

One or more stages to run in a pipeline associated with the release.

startingStage

String

The name of the starting stage.

webhookData

String

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

String

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.startRelease(
                projectName: 'test-projectName',
                releaseName: 'test-releaseName'
                /* optional arguments */)
property
report