GET /v1/getEntities - BlueCat Address Manager - 9.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.2.0

Description

Returns multiple entities for the specified parent ID.

Parameters

Name Description
count

Location: query

Type: integer (int32)

Indicates the maximum number of child objects to return.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
parentId

Location: query

Type: integer (int64)

The object ID of the parent object of the entities.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
start

Location: query

Type: integer (int32)

Indicates where in the list of child objects to start returning entities. The list begins at an index of 0.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
type

Location: query

Type: string

The type of object to be returned. This value must be one of the object types listed in Object types.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of entities. The array is empty if there are no matching entities.