GET /v1/getEntitiesByNameUsingOptions - BlueCat Integrity - 9.4.0

Address Manager API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.4.0

Description

Returns an array of entities that match the specified name and object type. Searching behavior can be changed by using the options.
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
count

Location: query

Type: integer (int32)

The maximum number of objects to return. The default value is 10.
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.
name

Location: query

Type: string

The name of the entity.
options

Location: query

Type: string

A string containing options. Currently the only available option is ignoreCase. By default, the value is set to false. Setting this option to true will ignore the case-sensitivity used while searching entities by name.
ignoreCase=[true|false]
parentId

Location: query

Type: integer (int64)

The object ID of the parent object of the entities to be returned.
start

Location: query

Type: integer (int32)

Indicates where in the list of returned objects to start returning objects. 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.