Description
Adds a vendor option definition to a vendor profile.
Parameters
Name | Description |
---|---|
allowMultiple |
Location: query Type: boolean Determines whether or not the custom option requires multiple values. The
default value is false.
In Perl script, only an empty string and 0 zero are considered as
false; other values are considered as true.
Therefore, a string containing the word “false” is considered to be
true because the string is not empty. In Perl, set the
allowMultipledata type to string and set the value to
either true or false:
Or, set the
allowMultipledata type to boolean. Set the value to
either 0or an empty string to represent false. Set the value to any other
text to represent true.
|
description |
Location: query Type: string A description of the vendor option.
|
name |
Location: query Type: string The name of the vendor option.
|
optionId |
Location: query Type: integer (int64) The deployment option ID. This value must be within the range of 1 to
254.
|
optionType |
Location: query Type: string The option type. This value must be one of the types listed in
Vendor profile option types.
|
properties |
Location: query Type: string Adds object properties, including user-defined fields. This value can be
empty.
|
vendorProfileId |
Location: query Type: integer (int64) The object ID of the vendor profile.
|
Responses
Code | Description |
---|---|
201 |
Type: integer (int64) Returns the object ID of the new vendor option definition.
|