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 which owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet which owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet which owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet which owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet which owns the property. |
catalogName |
String |
The name of the catalog of the property sheet which owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet which 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 which owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
containerName |
String |
The name of the container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet which 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 which owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet which owns the property. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD. |
environmentName |
String |
The name of the environment container of the property sheet which owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet which owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet which owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet which 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 which owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet which owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet which owns the property. |