Description
Returns multiple entities for the specified parent ID.
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 Legacy v1 API sessions.
Parameters
| Name | Description |
|---|---|
| count |
Location: query Type: integer (int32) Indicates the maximum number of child objects to return.
|
| includeHA |
Location: query Type: boolean An optional boolean flag for REST calls that sets the level of detail when
retrieving xHA pair server objects. Polling the xHA status of paired servers
during a search can cause delays, or connection timeouts if a server is
unreachable. When the parameter is set to true, the returned
xHA server object will include details for the xHA status of the nodes.
When set to false, the returned xHA server object will include
only basic information without polling xHA status of the servers. The default
value if omitted is true.
|
| parentId |
Location: query Type: integer (int64) The object ID of the parent object of the entities.
|
| 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.
|
| 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.
|