API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Catalog

4 minute readReference

createCatalog

Creates a new catalog.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

description

String

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

iconUrl

String

Set icon url for a catalog.

Positional arguments

projectName, catalogName

Usage

ec-perl

$cmdr->createCatalog(<projectName>, <catalogName>, {<optionals>});
▼

ectool

ectool createCatalog projectName,  catalogName, [optionals]
▼

createCatalogItem

Creates a new catalog item in a catalog.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

catalogItemName

String

(Required) The name of the catalog item.

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

subproject

String

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

templateObjectType

TemplateObjectType

The template object type.

useFormalParameter

Boolean

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

Positional arguments

projectName, catalogName, catalogItemName

Usage

ec-perl

$cmdr->createCatalogItem(<projectName>, <catalogName>, <catalogItemName>, {<optionals>});
▼

ectool

ectool createCatalogItem projectName,  catalogName,  catalogItemName, [optionals]
▼

deleteCatalog

Deletes a catalog.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

Positional arguments

projectName, catalogName

Usage

ec-perl

$cmdr->deleteCatalog(<projectName>, <catalogName>);
▼

ectool

ectool deleteCatalog projectName,  catalogName
▼

deleteCatalogItem

Deletes a catalog item.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

catalogItemName

String

(Required) The name of the catalog item.

Positional arguments

projectName, catalogName, catalogItemName

Usage

ec-perl

$cmdr->deleteCatalogItem(<projectName>, <catalogName>, <catalogItemName>);
▼

ectool

ectool deleteCatalogItem projectName,  catalogName,  catalogItemName
▼

getCatalog

Retrieves a catalog by name.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

Positional arguments

projectName, catalogName

Usage

ec-perl

$cmdr->getCatalog(<projectName>, <catalogName>);
▼

ectool

ectool getCatalog projectName,  catalogName
▼

getCatalogItem

Retrieves a catalog item by name.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

catalogItemName

String

(Required) The name of the catalog item.

Positional arguments

projectName, catalogName, catalogItemName

Usage

ec-perl

$cmdr->getCatalogItem(<projectName>, <catalogName>, <catalogItemName>);
▼

ectool

ectool getCatalogItem projectName,  catalogName,  catalogItemName
▼

getCatalogItems

Retrieves all catalog items for a catalog.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

Positional arguments

projectName, catalogName

Usage

ec-perl

$cmdr->getCatalogItems(<projectName>, <catalogName>);
▼

ectool

ectool getCatalogItems projectName,  catalogName
▼

getCatalogs

Retrieves all catalogs in a project.

Arguments

Argument Name Type Description

projectName

String

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

Positional arguments

projectName

Usage

ec-perl

$cmdr->getCatalogs(<projectName>);
▼

ectool

ectool getCatalogs projectName
▼

modifyCatalog

Modifies a catalog.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

description

String

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

iconUrl

String

Set icon url for a catalog.

newName

String

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

Positional arguments

projectName, catalogName

Usage

ec-perl

$cmdr->modifyCatalog(<projectName>, <catalogName>, {<optionals>});
▼

ectool

ectool modifyCatalog projectName,  catalogName, [optionals]
▼

modifyCatalogItem

Modifies an existing catalog item.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

catalogItemName

String

(Required) The name of the catalog item.

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

subproject

String

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

templateObjectType

TemplateObjectType

The template object type.

useFormalParameter

Boolean

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

Positional arguments

projectName, catalogName, catalogItemName

Usage

ec-perl

$cmdr->modifyCatalogItem(<projectName>, <catalogName>, <catalogItemName>, {<optionals>});
▼

ectool

ectool modifyCatalogItem projectName,  catalogName,  catalogItemName, [optionals]
▼

runCatalogItem

Run a catalog item.

Arguments

Argument Name Type Description

projectName

String

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

catalogName

String

(Required) The name of the catalog.

catalogItemName

String

(Required) The name of the catalog item.

actualParameters

Map

Parameters passed as arguments to the procedure or to DSL.

credentialReferenceParameters

Map

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

Collection

Credentials to be used in the job.

formParameters

Map

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.

Positional arguments

projectName, catalogName, catalogItemName

Usage

ec-perl

$cmdr->runCatalogItem(<projectName>, <catalogName>, <catalogItemName>, {<optionals>});
▼

ectool

ectool runCatalogItem projectName,  catalogName,  catalogItemName, [optionals]
▼
Artifact
Catalog item run