setComponentVersionPropDef#
Set a version property for a component
Component version properties are available to each version of the component.
Format#
udclient [\[global-args...\]](../../com.udeploy.reference.doc/topics/cli_command_format.md) [\[global-flags...\]](../../com.udeploy.reference.doc/topics/cli_command_format.md)
setComponentVersionPropDef [JSON file]
Parameters#
None.
Template#
This command takes a JSON request string or file. Use the following template for the request:
{
"allowedValues": "Comma separated list of allowed values
in SELECT or MULTI_SELECT properties (Optional)",
"component": "Name or ID of the component",
"description": "Description for the property (Optional)",
"label": "Label of the property (Optional)",
"name": "Name of the property to set",
"pattern": "A regular expression that specifies valid
values for the property (Optional)",
"required": "Whether the property is required (Optional,
Boolean)",
"type": "the type of property definition; valid values
are TEXT (the default), , TEXTAREA, CHECKBOX, SELECT,
MULTI_SELECT, DATETIME, and SECURE)",
"value": "Default value of the property definition
(Optional)"
}
Example#
udclient -username jsmith -password passwd
-weburl https://myserver.example.com:8443
setComponentVersionPropDef
-component JPetStore-APP
-name Prop1
-value true
-type CHECKBOX
Example response#
{
"id": "870bc2f5-55e2-4cb9-b3ab-f750688754b9",
"name": "Prop1",
"type": "CHECKBOX",
"value": "prop1",
"required": false
}
Related REST command: Set a version property for a component.
Parent topic: CLI Commands