APIUserDefinedField Class - BlueCat Address Manager - 9.0.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.0.0

User-defined fields can be added to each of the Address Manager object types. This class allows API users to query and gather user-defined fields information for a specified object type.

Value Description
name the internal name of the user-defined field.
displayname the name of the user-defined field that appears to users in the Address Manager interface.
type the type of the user-defined field. Types are available as constants in the UserDefinedFieldType class. For available constants, refer to User-defined Field Type.
defaultValue the default value for the user-defined field.
validatorProperties the validation properties for the user-defined field. Property names are available as constants in the UserDefinedFieldValidatorProperties class. For available constants, refer to User-defined Field Validator Properties.
required the boolean value. If set to true, users must enter data in the field.
hideFromSearch the boolean value. If set to true, the user-defined field is hidden from the search.
renderAsRadioButton the boolean value. If set to true, the user-defined field is rendered as a radio button group.