Using the Perl API
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
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Persona

2 minute readReference

addPersonaDetail

Adds a persona detail to a given persona.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

personaCategoryName

String

The persona category name. (Required)

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.addPersonaDetail(
                personaName: 'test-personaName',
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)
▼

createPersona

Create a new persona.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

description

String

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

homePageName

String

The default home page.

isDefault

Boolean

Set as default persona.

personaDetails

String

The details of the persona, if creating.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deletePersona

Delete a persona.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePersona(
                personaName: 'test-personaName')
▼

getPersona

Find a persona by name.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersona(
                personaName: 'test-personaName')
▼

getPersonas

Retrieve all personas.

Arguments

Argument Name Type Description

excludeGroupPersonas

Boolean

If true, exclude personas set for groups when specify userName.

groupName

String

The group name.

includeDetails

Boolean

True to include details (default is false)

merged

Boolean

If true, merge the persona details when specify userName.

userName

String

The user name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonas(
                /* optional arguments */)
▼

modifyPersona

Modify an existing persona.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

clearDetails

Boolean

clear persona details, if modifying.

description

String

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

homePageName

String

The default home page.

isDefault

Boolean

Set as default persona.

newName

String

New name for an existing object that is being renamed.

personaDetails

String

The details of the persona, if creating.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removePersonaDetail

delete a persona detail.

Arguments

Argument Name Type Description

personaName

String

The persona name. (Required)

personaCategoryName

String

The persona category name. (Required)

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.removePersonaDetail(
                personaName: 'test-personaName',
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)
▼
outputparameter
personacategory