Get Entities - BlueCat Address Manager - 9.0.0

Address Manager API Guide

English (United States)
Product name
BlueCat Address Manager

Returns an array of requested child objects for a given parentId value. Some objects returned in the array may not have their properties field set. For those objects, you will need to call them individually using the getEntityById() method to populate the properties field.

  • Using getEntities() to search users will return all users existing in Address Manager. Use getLinkedEntities() or linkEntities() to search users under a specific user group.
  • Using getEntities() to query server objects in configurations containing XHA pairs might result in a connection timeout if any of the servers in an XHA pair are not reachable.
  • Using getEntities() to query an xHA pair returns a single entity as the xHA pair.
Output / Response

Returns an array of the requested objects from the database without their properties fields populated, or returns an empty array.

API call:

APIEntity[] getEntities( long parentId, String type, int start, int count )
Parameter Description
parentId The object ID of the target object’s parent object.
type The type of object returned. This must be one of the constants listed in Object Types.
start Indicates where in the list of objects to start returning objects. The list begins at an index of 0.
count Indicates the maximum number of child objects to return.