GET /v1/getEntitiesByNameUsingOptions - BlueCat Address Manager - 9.1.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.1.0

Description

Returns an array of entities that match the specified name and object type. Searching behavior can be changed by using the options.

Parameters

Name Description
count

Location: query

Type: integer (int32)

The maximum number of objects to return. The default value is 10. This value cannot be null or empty.
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 ObjectProperties.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.
ObjectProperties.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. This value cannot be null or empty.
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.