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

State commands

1 minute readReference
On this page

getState

Find a state by name.

Arguments

Argument Name Type Description

projectName

String

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

workflowName

String

The name of the workflow. (Required)

stateName

String

The name used for the new state (Required)

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getState(
                projectName: 'test-projectName',
                workflowName: 'test-workflowName',
                stateName: 'test-stateName')
▼

getStates

Retrieve all states in a workflow.

Arguments

Argument Name Type Description

projectName

String

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

workflowName

String

The name of the workflow. (Required)

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getStates(
                projectName: 'test-projectName',
                workflowName: 'test-workflowName')
▼
stage
statedef