API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Workspace

2 minute readReference

createWorkspace

Creates a new workspace.

Arguments

Argument Name Type Description

workspaceName

String

The workspace name.(Required)

agentDrivePath

String

Pathname to the root directory of a workspace, for use on Windows, specified with a drive letter.

agentUncPath

String

Pathname to the root directory of a workspace, for use on Windows, specified with a UNC path.

agentUnixPath

String

Pathname to the root directory of a workspace, for use on UNIX.

credentialName

String

The name of the impersonation credential to attach to this workspace.

description

String

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

local

Boolean

True if the workspace is local.

workspaceDisabled

Boolean

True means this workspace is disabled.

zoneName

String

The zone name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createWorkspace(
                workspaceName: 'test-workspaceName'
                /* optional arguments */)

deleteWorkspace

Deletes a workspace.

Arguments

Argument Name Type Description

workspaceName

String

The workspace name.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteWorkspace(
                workspaceName: 'test-workspaceName')

getWorkspace

Retrieves a workspace by its name.

Arguments

Argument Name Type Description

workspaceName

String

The workspace name.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getWorkspace(
                workspaceName: 'test-workspaceName')

getWorkspaces

Retrieves all workspaces.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getWorkspaces()

modifyWorkspace

Modifies an existing workspace.

Arguments

Argument Name Type Description

workspaceName

String

The workspace name.(Required)

agentDrivePath

String

Pathname to the root directory of a workspace, for use on Windows, specified with a drive letter.

agentUncPath

String

Pathname to the root directory of a workspace, for use on Windows, specified with a UNC path.

agentUnixPath

String

Pathname to the root directory of a workspace, for use on UNIX.

credentialName

String

The name of the impersonation credential to attach to this workspace.

description

String

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

local

Boolean

True if the workspace is local.

newName

String

The new name for an existing object that is being renamed.

workspaceDisabled

Boolean

True means this workspace is disabled.

zoneName

String

The zone name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyWorkspace(
                workspaceName: 'test-workspaceName'
                /* optional arguments */)
workitem
zone