CatalogItem

4 minute readReference

createCatalogItem

Creates a new catalog item in a catalog.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

catalogItemName

String

The name of the catalog item.(Required)

afterItem

String

If specified, the catalog item will be placed after the named catalog item.

allowScheduling

Boolean

If specified, the schedules/triggers creation is allowed for a catalog item.

beforeItem

String

If specified, the catalog item will be placed before the named catalog item.

buttonLabel

String

The name of the button label.

description

String

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

dslParamForm

String

The DSL Parameter form Metadata.

dslString

String

The DSL string that is evaluated for the catalog item.

endTargetJson

String

The JSON derived end target object.

firstItem

Boolean

True to make a catalog item the first in a catalog.

iconUrl

String

The URL for the icon to be used in UI.

subpluginKey

String

The name of the procedure’s pluginKey.

subprocedure

String

The name of the subprocedure.

subproject

String

The name of the project that contains the subprocedure or subprocess.

templateObjectType

String

The template object type.

useFormalParameter

Boolean

If true, the catalog item uses formalParameters data. If false, formXml is used. Also, when useFormalParameter is true, a check validation determines if the actual parameter is passed into the runCatalogItem API. If useFormalParameter is false but the actual parameter is present, an error is returned.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createCatalogItem(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName',
                catalogItemName: 'test-catalogItemName'
                /* optional arguments */)

deleteCatalogItem

Deletes a catalog item.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

catalogItemName

String

The name of the catalog item.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCatalogItem(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName',
                catalogItemName: 'test-catalogItemName')

deleteCatalogItemRun

Deletes a catalog item run.

Arguments

Argument Name Type Description

catalogItemRunId

String

The ID of the catalog item run.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCatalogItemRun()

getCatalogItem

Retrieves a catalog item by name.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

catalogItemName

String

The name of the catalog item.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCatalogItem(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName',
                catalogItemName: 'test-catalogItemName')

getCatalogItems

Retrieves all catalog items for a catalog.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCatalogItems(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName')

modifyCatalogItem

Modifies an existing catalog item.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

catalogItemName

String

The name of the catalog item.(Required)

afterItem

String

If specified, the catalog item will be placed after the named catalog item.

allowScheduling

Boolean

If specified, the schedules/triggers creation is allowed for a catalog item.

beforeItem

String

If specified, the catalog item will be placed before the named catalog item.

buttonLabel

String

The name of the button label.

description

String

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

dslParamForm

String

The DSL Parameter form Metadata.

dslString

String

The DSL string that is evaluated for the catalog item.

endTargetJson

String

The JSON derived end target object.

firstItem

Boolean

True to make a catalog item the first in a catalog.

iconUrl

String

The URL for the icon to be used in UI.

newName

String

The new name for an existing object that is being renamed.

subpluginKey

String

The name of the procedure’s pluginKey.

subprocedure

String

The name of the subprocedure.

subproject

String

The name of the project that contains the subprocedure or subprocess.

templateObjectType

String

The template object type.

useFormalParameter

Boolean

If true, the catalog item uses formalParameters data. If false, formXml is used. Also, when useFormalParameter is true, a check validation determines if the actual parameter is passed into the runCatalogItem API. If useFormalParameter is false but the actual parameter is present, an error is returned.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyCatalogItem(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName',
                catalogItemName: 'test-catalogItemName'
                /* optional arguments */)

runCatalogItem

Run a catalog item.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

catalogName

String

The name of the catalog.(Required)

catalogItemName

String

The name of the catalog item.(Required)

actualParameters

Parameters passed as arguments to the procedure or to DSL.

credentialReferenceParameters

array

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Credential array

Credentials to be used in the job.

formParameters

Parameters passed as arguments to the DSL.

parsedWebhookData

String

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

scheduleName

String

Name for the schedule; must be unique among all schedules for the project.

webhookData

String

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

String

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.runCatalogItem(
                projectName: 'test-projectName',
                catalogName: 'test-catalogName',
                catalogItemName: 'test-catalogItemName'
                /* optional arguments */)