Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange 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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Component

6 minute readReference

attachCredential

Attaches a credential to an object, such as a step or a schedule. Attaching a credential allows the credential to be passed as an actual argument by a schedule or subprocedure step, or to be used in a getFullCredential call by a command step.

Arguments

Argument Name Type Description

projectName

String

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

credentialName

String

The name of the credential. (Required)

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

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

catalogItemName

String

The name of the catalog item, if attaching a credential to a catalog item.

catalogName

String

The name of the catalog, if attaching a credential to a catalog.

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

String

The type of the gate.

microserviceName

String

The name of the microservice, if attaching a credential to a microservice process.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

triggerName

String

The name of the trigger, if attaching a credential to a trigger.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

copyComponent

Creates a new component based on an existing one.

Arguments

Argument Name Type Description

componentName

String

The name of the component. (Required)

newComponentName

String

The name of new component. (Required)

projectName

String

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

applicationTierName

String

The name of the tier.

description

String

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

fromApplicationName

String

The name of the source application.

toApplicationName

String

The name of the source application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

createComponent

Creates a new component for a project.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component. (Required)

actualParameters

ActualParameter array

Parameters passed as arguments to the application component.

applicationName

String

The name of an application to scope this component to.

credentialName

String

The name of a credential to attach to this component.

description

String

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

pluginKey

String

The key of the plugin.

pluginName

String

The name of the plugin.

pluginParameters

PluginParameter array

List of plugin parameters.

reference

Boolean

If 1 or true, a reference of the component is created. If 0 or false, a copy of the component is created.

sourceApplicationName

String

The name of the source application.

sourceComponentName

String

The name of new component.

sourceProjectName

String

The name of source project.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteComponent

Deletes a component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component. (Required)

applicationName

String

The name of an application to scope this component to.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

detachCredential

Detach a credential from an object.

Arguments

Argument Name Type Description

projectName

String

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

credentialName

String

The name of the credential. (Required)

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

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

catalogItemName

String

The name of the catalog item, if attaching a credential to a catalog item.

catalogName

String

The name of the catalog, if attaching a credential to a catalog.

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

String

The type of the gate.

microserviceName

String

The name of the microservice, if attaching a credential to a microservice process.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

triggerName

String

The name of the trigger, if attaching a credential to a trigger.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponent

Retrieves a component by name.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component. (Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

applicationName

String

The name of an application to scope this component to.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponents

Retrieves all components in a project.

Arguments

Argument Name Type Description

projectName

String

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

applicationEntityRevisionId

String

The revision ID of the versioned object.

applicationName

String

Name of the application. Specify to search for components scoped to an application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponentsInApplicationTier

Retrieves the list of components in an application tier.

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)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

includeArtifactDetail

Boolean

Retrieves artifact name and version as part of component response.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyComponent

Modifies an existing component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component. (Required)

actualParameters

ActualParameter array

Parameters passed as arguments to the application component.

applicationName

String

The name of an application to scope this component to.

clearActualParameters

Boolean

If true, the step should remove all actual parameters.

credentialName

String

The name of a credential to attach to this component.

description

String

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

newName

String

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

pluginKey

String

The key of the plugin.

pluginName

String

The name of the plugin.

pluginParameters

PluginParameter array

List of plugin parameters.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeComponentFromApplicationTier

Removes the specified component from an application tier.

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)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

componentName

String

Name of the component. (Required)

componentProjectName

String

Project name of the component.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeComponentFromApplicationTier(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                applicationTierName: 'test-applicationTierName',
                componentName: 'test-componentName'
                /* optional arguments */)
▼
cluster
credential