GET /v1/getZonesByHint - BlueCat Integrity - 9.4.0

Address Manager API Guide

Product name
BlueCat Integrity


Returns an array of accessible zones of child objects for a given containerId value.
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.


Name Description

Location: query

Type: integer (int64)

The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object can be the configuration level.

Location: query

Type: integer (int32)

Indicates the maximum number of child objects that this method will return. The maximum number of child objects cannot exceed more than 10.

Location: query

Type: string

A string containing options. The Option names available in the ObjectProperties are ObjectProperties.hint, ObjectProperties.accessRight, and ObjectProperties.overrideType. Multiple options can be separated by a pipe character. For example:
The values for ObjectProperties.hint option can be the prefix of a zone name. For example:
String options = ObjectProperties.hint + "=abc|"
The values for the ObjectProperties.accessRight and ObjectProperties.overrideType options must be one of the constants listed in Access right values and Object types. For example:
String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess +
"|"+ ObjectProperties.overrideType + "=" + ObjectTypes.HostRecord;

Location: query

Type: integer (int32)

Indicates where in the list of objects to start returning objects. The list begins at an index of 0.


Code Description

Type: Array of APIEntity

Returns an array of zones based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default.