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

PersonaCategory

Reference

createPersonaCategory

Create a new persona category.

Arguments

Argument NameTypeDescription

personaCategoryName

String

The persona category name. (Required)

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

description

String

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

enabled

Boolean

Whether to enable the PersonaCategory.

personaPages

String array

list of pages in persona category

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createPersonaCategory(
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)

deletePersonaCategory

delete a personaCategory by name.

Arguments

Argument NameTypeDescription

personaCategoryName

String

The persona category name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePersonaCategory(
                personaCategoryName: 'test-personaCategoryName')

getPersonaCategories

Find all personaCategories.

Arguments

Argument NameTypeDescription

includeDisabled

Boolean

Whether to include disabled PersonaCategories.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPersonaCategory

Find a personaCategory by name.

Arguments

Argument NameTypeDescription

personaCategoryName

String

The persona category name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaCategory(
                personaCategoryName: 'test-personaCategoryName')

modifyPersonaCategory

Modify an existing persona category.

Arguments

Argument NameTypeDescription

personaCategoryName

String

The persona category name. (Required)

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

clearPages

Boolean

clear persona pages for the category, if modifying.

description

String

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

enabled

Boolean

Whether to enable the PersonaCategory.

newName

String

New name for an existing object that is being renamed.

personaPages

String array

list of pages in persona category

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPersonaCategory(
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)
persona
personapage