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
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
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

Application commands

3 minute readReference

createApplication

Creates a new application for a project.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteApplication

Deletes an application

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

foreground

Boolean

True to delete the object in the foreground. The default is to delete the object in the background.

retainInventory

Boolean

True if you wish to retain inventory after deleting the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getApplication

Find a application by name.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

applicationEntityRevisionId

String

Revisionid of the versioned object

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getApplicationDependencies

Gets the dependencies of an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentServiceName

String

The name of service which this application depends on.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getApplications

Retrieve all applications in a project.

Arguments

Argument Name Type Description

projectName

String

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

includeEntityRevisions

Boolean

Include the revisions of application the search results

referenceComponentName

String

name of the master component.

referenceComponentProject

String

project name of the master component.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getDeployTopology

Retrieves application and services dependencies along with cluster and environment information that will be required to render the topology view.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.

clusterName

String

The name of the cluster.

environmentName

String

The name of the environment.

serviceName

String

The name of the service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getEnvironmentApplications

Retrieve a list of applications installed on the given environment

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

The name of the environment. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentApplications(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName')
▼

getPartialApplicationRevision

Returns partial application object for snapshot creation

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

revisionNumber

Integer

Revision number (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPartialApplicationRevision(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                revisionNumber: 'test-revisionNumber')
▼

getServiceDependencies

Gets the dependencies of an service.

Arguments

Argument Name Type Description

projectName

String

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

serviceName

String

The name of the service (Required)

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentServiceName

String

The name of service which this application depends on.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyApplication

Modifies an existing application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

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

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼
appdep
appservicemapping