Roadmap to CloudBees CD/RO APIs
CloudBees CD/RO command line access
Using DSL
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
Perl API response and element glossary
Using the Groovy API
Groovy API reference
accesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuserutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Artifact

Reference

createArtifact

Creates a new artifact.

Arguments

Argument NameTypeDescription

artifactKey

String

The artifactKey component of the GAV (GroupId/ArtifactKey/Version) coordinates.

artifactVersionNameTemplate

String

The artifactVersion name template.

description

String

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

groupId

String

The groupId component of the GAV (GroupId/ArtifactKey/Version) coordinates.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteArtifact

Deletes an artifact.

Arguments

Argument NameTypeDescription

artifactName

String

The name of the artifact. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteArtifact(
                artifactName: 'test-artifactName')

getArtifact

Find an artifact by name.

Arguments

Argument NameTypeDescription

artifactName

String

The name of the artifact. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getArtifact(
                artifactName: 'test-artifactName')

getArtifacts

Retrieve all artifacts in the system.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getArtifacts()

modifyArtifact

Modifies an existing artifact.

Arguments

Argument NameTypeDescription

artifactName

String

The name of the artifact

artifactVersionNameTemplate

String

The artifactVersion name template.

description

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyArtifact(
                /* optional arguments */)
archiveconnector
artifactversion