GET /v1/getUserDefinedFields - BlueCat Address Manager

GET /v1/getUserDefinedFields - BlueCat Address Manager - 9.2.0

Address Manager API Guide

Locale

English (United States)

Product name

BlueCat Address Manager

Version

9.2.0

Returns the user-defined fields information.

Name	Description
requiredFieldsOnly	Location: query Type: boolean Specifies whether all user-defined fields of the object type will be returned or not. If set to true, only required fields will be returned. Note: Starting in Address Manager API v9.2.0, this parameter is now required.
type	Location: query Type: string The type of object the user-defined field belongs to. This must be one of the constants listed in Object types.

Name

Description

requiredFieldsOnly

Location: query

Type: boolean

Specifies whether all user-defined fields of the object type will be returned or not. If set to true, only required fields will be returned.

Note: Starting in Address Manager API v9.2.0, this parameter is now required.

type

Location: query

Type: string

The type of object the user-defined field belongs to. This must be one of the constants listed in Object types.

Code	Description
200	Type: Array of APIUserDefinedField Returns the user-defined fields information.