Add Vendor Option Definition - BlueCat Address Manager - 9.0.0

Address Manager API Guide

English (United States)
Product name
BlueCat Address Manager

Adds a vendor option definition to a vendor profile.

Output / Response

Returns the object ID of the new vendor option definition.

API call:

long addVendorOptionDefinition ( long vendorProfileId, long optionId, String name, String optionType, String description, boolean allowMultiple, String properties )
Parameter Description
vendorProfileId The object ID of the vendor profile.
optionId The deployment option ID. This value must be within the range of 1 to 254.
name The name of the vendor option. This value cannot be empty.
optionType The option type. This value must be one of the types listed in Vendor Profile Option Types.
description A description of the vendor option. This value cannot be empty.
allowMultiple Determines whether or not the custom option requires multiple values. The default value is false. This value cannot be empty.
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:
SOAP::Data->type( 'string' )->
name( 'allowMultiple' )->
value( "false")->
attr({xmlns => ''})
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.
SOAP::Data->type( 'boolean' )
->name( 'allowMultiple' )
->value( 0 )
->attr({xmlns => ''})
properties Adds object properties, including user-defined fields. This value can be empty.