POST /v1/addVendorOptionDefinition - BlueCat Address Manager - 9.2.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.2.0

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:
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 => ''})
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
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.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
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.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.

Responses

Code Description
201

Type: number

Returns the object ID of the new vendor option definition.