Index
modifyEnvTemplTierResourceTemplMapping
getPluginCatalog
getResourceUsage
getRetrievedArtifacts
runDiscovery
getServerSettings
getServerSettingsCategories
revokeToken
getWorkItems
ActionParameterActualParameterAdditionalFilterAttributeDataTypeAttributePathCfgMgrParameterCloudProviderParameterColorComponentVersionCredentialCredentialReferenceParameterDefinitionParameterDefinitionSourceParameterDeployParameterDestinationMappingExportParameterFieldFilterFormParameterHookActualParameterHookParameterImportParameterLinkParameterOptionPipelineParameterPluginParameterProvisionParameterReleaseFlowRuntimeMappingResourcePhaseMappingResourcePoolPhaseMappingRollbackParameterSelectSortTierMappingTierResourceCountVisualizationProperty

modifyCatalogItem

On this page
Back to index

Summary

Modifies an existing catalog item.
projectName
Stringrequired
The name for the project that must be unique among all projects.
catalogName
Stringrequired
The name of the catalog.
catalogItemName
Stringrequired
The name of the catalog item.
afterItem
Stringoptional
If specified, the catalog item will be placed after the named catalog item.
allowScheduling
Booleanoptional
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
Booleanoptional
True to make a catalog item the first in a catalog.
iconUrl
Stringoptional
The URL for the icon to be used in UI. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
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.
Possible values: "none", "release"
useFormalParameter
Booleanoptional
If true catalog item uses formalParameters data, if false formXml will be used.

Usage

Groovy

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 */
)
▼