Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory 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
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

PersonaPage

2 minute readReference

addPageToPersonaCategory

Adds a persona page to a given category.

Arguments

Argument NameTypeDescription

personaCategoryName

String

The persona category name. (Required)

personaPageName

String

The persona page name. (Required)

afterPage

String

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

beforePage

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

addPersonaSubpage

Adds a persona subpage(s) to a given page.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

personaPages

String array

list of subpages

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addPersonaSubpage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

createPersonaPage

Create a new persona page.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

description

String

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

subpages

String array

list of subpages

url

String

The persona page url.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createPersonaPage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

deletePersonaPage

delete a personaPage by name.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePersonaPage(
                personaPageName: 'test-personaPageName')

getPersonaPage

Find a personaPage by name.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaPage(
                personaPageName: 'test-personaPageName')

getPersonaPages

Find all personaPages.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaPages()

modifyPersonaPage

Modify an existing persona page.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

description

String

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

newName

String

New name for an existing object that is being renamed.

subpages

String array

list of subpages

url

String

The persona page url.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPersonaPage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

removePersonaSubpage

Delete a persona subpage.

Arguments

Argument NameTypeDescription

personaPageName

String

The persona page name. (Required)

personaPages

String array

list of subpages

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removePersonaSubpage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)
personacategory
pipeline