Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobStepkerberosKeytablicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

catalogItem

On this page
Back to index

Summary

Self Service dashboard catalog item.
catalogItemName
Stringrequired
The name of the catalog item.
catalogName
Stringrequired
The name of the catalog.
projectName
Stringrequired
The name for the project that must be unique among all projects.
afterItem
Stringoptional
If specified, the catalog item will be placed after the named catalog item.
allowScheduling
Stringoptional
If specified, the schedules/triggers creation is allowed for a catalog item.
beforeItem
Stringoptional
If specified, the catalog item will be placed before the named catalog item.
buttonLabel
Stringoptional
The name of the button label.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
dslParamForm
Stringoptional
The DSL Parameter form Metadata.
dslString
Stringoptional
The DSL string that is evaluated for the catalog item.
endTargetJson
Stringoptional
The JSON derived end target object.
firstItem
Stringoptional
True to make a catalog item the first in a catalog.
iconUrl
Stringoptional
The URL for the icon to be used in UI.
newName
Stringoptional
The new name for an existing object that is being renamed.
subpluginKey
Stringoptional
The name of the procedure's pluginKey.
subprocedure
Stringoptional
The name of the subprocedure.
subproject
Stringoptional
The name of the project that contains the subprocedure or subprocess.
templateObjectType
Stringoptional
The template object type.
useFormalParameter
Stringoptional
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

There are no usage examples available for catalogItem.