GET /v1/getUserDefinedFields - BlueCat Integrity - 9.3.0

Address Manager API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.3.0

Description

Returns the user-defined fields information.
Note: This API method supports read-only API sessions. For more information on read-only API sessions and a list of API methods that support read-only API session, refer to Read-only API sessions.

Parameters

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.
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.

Responses

Code Description
200

Type: Array of APIUserDefinedField

Returns the user-defined fields information.