createProperty
Create a property using a combination of property path and context.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProtected |
Boolean |
If true, then permissions requiring modify privileges on the property sheet being manipulated will also require execute privileges on credentials attached to the property sheet owner. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
expandable |
Boolean |
Whether or not the property is recursively expandable. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
propertyType |
String |
Type of property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
suppressValueTracking |
Boolean |
If true, then change tracking will ignore changes that only affect the value of the property, and exports of past states and force imports will preserve the current value. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
value |
String |
The value of the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
deleteProperty
Delete a property from a property sheet.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
findProperties
Return properties of a particular object.
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
filters |
Filter array |
A list of zero or more filter criteria definitions used to define objects to find. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
maxIds |
Integer |
The maximum number of object IDs to return. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
numObjects |
Integer |
The number of objects to return as the first page of results. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
sorts |
Sort array |
Sort specifications. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
getProperties
Return all properties associated with an object, along with the property sheet identifier of the object’s property sheet.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
expand |
Boolean |
If true, property values are expanded. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertyName |
String |
The name of a nested property sheet. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
recurse |
Boolean |
True means nested property sheets are included. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
getProperty
Get value of the specified property.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
expand |
Boolean |
If true, property values are expanded. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
incrementProperty
Atomically increments an integer property by the specified amount and returns the new value.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
incrementBy |
Integer |
The amount by which to increment the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
modifyProperty
Modifies a regular string or nested property sheet using a combination of property path and context.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProtected |
Boolean |
If true, then permissions requiring modify privileges on the property sheet being manipulated will also require execute privileges on credentials attached to the property sheet owner. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
expandable |
Boolean |
Whether or not the property is recursively expandable. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
newName |
String |
The new name for an existing object that is being renamed. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
propertyType |
String |
Type of property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
suppressValueTracking |
Boolean |
If true, then change tracking will ignore changes that only affect the value of the property, and exports of past states and force imports will preserve the current value. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
value |
String |
The value of the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
setProperty
Sets the value for the specified property.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
propertyName |
String |
Name for the property; must be unique within the property sheet.(Required) |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
expandable |
Boolean |
Whether or not the property is recursively expandable. |
extendedContextSearch |
Boolean |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
String |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
String |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
path |
String |
Property path string. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
String |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
suppressValueTracking |
Boolean |
If true, then change tracking will ignore changes that only affect the value of the property, and exports of past states and force imports will preserve the current value. |
systemObjectName |
String |
The system object. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
value |
String |
The value of the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |