Using the Perl API
Perl API reference
IntroductionACL 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 managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

FlowRuntime

5 minute readReference

abortPipelineRun

Abort a pipeline run.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime

flowRuntimeName

String

The name of the flow runtime

force

Boolean

If true running tasks are force aborted.

projectName

String

The name of the project

Usage

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


ElectricFlow ef = new ElectricFlow()

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

completeManualTask

Complete manual task operation.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime (Required)

stageName

String

The name of the stage (Required)

taskName

String

The name of the task (Required)

action

String

The type of action to be taken on the manual process step or manual task or gate task

actualParameters

ActualParameter array

Actual parameters passed to an invoked subprocedure

evidence

String

Evidence provided while taking an action on the manual process step or manual task or gate task

gateType

String

The type of the gate.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.completeManualTask(
                flowRuntimeId: 'test-flowRuntimeId',
                stageName: 'test-stageName',
                taskName: 'test-taskName'
                /* optional arguments */)

completeRuntimeWaitDependency

Complete a wait dependency for a stage or task

Arguments

Argument Name Type Description

flowRuntimeId

String

The UUID of the invoking flowRuntime.

projectName

String

The name for the project that contains the wait dependency.

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

runtimeWaitDependencyName

String

The name of the runtimeWaitDependency.

dependentFlowRuntimeId

String

The UUID of the dependent flowRuntime.

dependentGateType

String

The type of dependent gate.

dependentPipelineName

String

The name of the dependent pipeline

dependentProjectName

String

The name of the dependent project

dependentReleaseName

String

The name of the dependent release

dependentStageName

String

The name of the dependent stage

dependentTaskName

String

The name of the dependent task

gateType

String

The type of gate.

releaseName

String

The name of the release

taskName

String

The name of the task

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deletePipelineRun

Deletes a pipeline runtime

Arguments

Argument Name Type Description

projectName

String

The name of the project

flowRuntimeId

String

The id of the flow runtime

flowRuntimeName

String

The name of the flow runtime

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPipelineRunAuditReport

[PREVIEW] This API is in preview mode, and therefore subject to change. Get pipeline runtime audit report.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the pipeline or release run to generate the audit report

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPipelineRunAuditReport()

getPipelineRuntimeDetails

Get pipeline runtime details.

Arguments

Argument Name Type Description

flowRuntimeIds

String array

List of pipeline flowruntime ids of interest.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPipelineRuntimes

Return pipeline runs.

Arguments

Argument Name Type Description

projectName

String

The name of the project

releaseName

String

The name of the release

filters

Filter array

Filters

firstResult

Integer

Result pagination: the first row to return.

flowRuntimeId

String

The id of the flow runtime

flowRuntimeName

String

The name of the flow runtime

maxResults

Integer

Result pagination: the number of rows to return.

pipelineName

String

The name of the pipeline

releaseId

String

The id of the release

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.getPipelineRuntimes(
                /* optional arguments */)

getReleaseTimelineDetails

Get planned versus actual time details for 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 (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getRunHierarchy

Get pipeline or release run hierarchy

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime

filters

Filter array

Filters

mode

String

The mode of portfolio view

pipelineName

String

The name of the pipeline

projectName

String

The name of the project

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.getRunHierarchy(
                /* optional arguments */)

getRuntimeWaitDependencies

Get all pipeline dependencies on a pipeline run.

Arguments

Argument Name Type Description

flowRuntimeId

String

The UUID of the invoking flowRuntime. (Required)

stageName

String

The name of the stage

gateType

String

The type of gate.

taskName

String

The name of the task

Usage

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


ElectricFlow ef = new ElectricFlow()

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

restartPipelineRun

Restart a pipeline run.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime

actualParameters

ActualParameter array

The list of actual parameters.

comment

String

Comment provided while restarting pipeline run which has completed with error.

flowRuntimeName

String

The name of the flow runtime

gateType

String

The type of the gate.

projectName

String

The name of the project

stageName

String

The name of a stage from which to restart a pipeline.

taskName

String

The name of a high-level task in the last active stage from which to restart a pipeline.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

retryTask

Continue to run pipeline flow runtime if it there are tasks waiting on error.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime (Required)

stageName

String

The name of the stage (Required)

taskName

String

The name of the task (Required)

action

String

Action to execute: rerun (default), skip or fail the task

comment

String

Comment provided while retry an action on the manual process step or manual task or gate task

gateType

String

The type of the gate.

subapplication

String

The name of the sub application.

subproject

String

The name of the project that contains the sub application

subservice

String

The name of the sub service.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.retryTask(
                flowRuntimeId: 'test-flowRuntimeId',
                stageName: 'test-stageName',
                taskName: 'test-taskName'
                /* optional arguments */)

runFutureTask

run a task out of order - in a stage or gate that hasn’t started yet.

Arguments

Argument Name Type Description

flowRuntimeId

String

The id of the flow runtime (Required)

stageName

String

The name of the stage (Required)

taskName

String

The name of the task (Required)

gateType

String

The type of the gate.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.runFutureTask(
                flowRuntimeId: 'test-flowRuntimeId',
                stageName: 'test-stageName',
                taskName: 'test-taskName'
                /* optional arguments */)

runPipeline

Run the specified pipeline, return the flowRuntimeId.

Arguments

Argument Name Type Description

pipelineName

String

The name of the pipeline (Required)

projectName

String

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

actualParameters

ActualParameter array

The list of actual parameters.

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.

priority

String

The priority of jobs launched by the pipeline.

releaseName

String

The name of 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.

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.runPipeline(
                pipelineName: 'test-pipelineName',
                projectName: 'test-projectName'
                /* optional arguments */)

setPipelineRunName

Sets the name of a running pipeline.

Arguments

Argument Name Type Description

newName

String

The new name for the flow runtime. (Required)

flowRuntimeId

String

The primary key of the completed flowRuntime.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.setPipelineRunName(
                newName: 'test-newName'
                /* optional arguments */)
eventsubscription
formaloutputparameter