IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory 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
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

CatalogItem commands

3 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.

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 Flow.

dslParamForm

String

The DSL Parameter form Metadata

dslString

String

The dsl string that is evaluated for the catalog item

endTargetJson

String

The Json desrived 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 sub procedure.

subproject

String

The name of the project that contains the sub procedure or sub process

useFormalParameter

Boolean

If true catalog item uses formalParameters data, if false formXml will be used

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteCatalogItem

Delete 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.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getCatalogItem

Retrieve 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.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getCatalogItems

Retrieve all catalog items for 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.apis.model.*


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.

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 Flow.

dslParamForm

String

The DSL Parameter form Metadata

dslString

String

The dsl string that is evaluated for the catalog item

endTargetJson

String

The Json desrived 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

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 sub procedure.

subproject

String

The name of the project that contains the sub procedure or sub process

useFormalParameter

Boolean

If true catalog item uses formalParameters data, if false formXml will be used

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


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

actualParameter array

Parameters passed as arguments to the procedure or to dsl.

formParameters

formParameter array

Parameters passed as arguments to the dsl.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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