Persona

addPersonaDetail

Creates a new personaDetail object.

Arguments

Argument Name	Type	Description
personaName	String	The persona name. (Required)
personaCategoryName	String	The persona category name. (Required)
personaPages	String array	A list of pages in a persona category.

Argument Name

Type

Description

personaName

String

The persona name. (Required)

personaCategoryName

String

The persona category name. (Required)

personaPages

String array

A list of pages in a 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

Creates a new persona object.

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.

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

Deletes the specified persona.

Arguments

Argument Name	Type	Description
personaName	String	The persona name. (Required)

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

Retrieves the specified persona.

Arguments

Argument Name	Type	Description
personaName	String	The persona name. (Required)

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

Retrieves persona objects subject to specified criteria sent with the request. If no arguments are specified, all personas in the system are returned, sorted by persona name.

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.

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

Modifies the specified persona object.

Arguments

Argument Name	Type	Description
personaName	String	The persona name. (Required)
clearDetails	Boolean	Clears 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	The new name for an existing object that is being renamed.
personaDetails	String	The details of the persona, if creating.

Argument Name

Type

Description

personaName

String

The persona name. (Required)

clearDetails

Boolean

Clears 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

The 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

Removes a personaDetail object.

Arguments

Argument Name	Type	Description
personaName	String	The persona name. (Required)
personaCategoryName	String	The persona category name. (Required)
personaPages	String array	A list of pages in a persona category.

Argument Name

Type

Description

personaName

String

The persona name. (Required)

personaCategoryName

String

The persona category name. (Required)

personaPages

String array

A list of pages in a 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 */)▼