GET /v1/searchByObjectTypes - 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 by searching for keywords associated with objects of a specified object type. You can search for multiple object types with a single method call.

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.
keyword

Location: query

Type: string

The search keyword string. This value cannot be null or empty.
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.
types

Location: query

Type: string

The object types for which to search, specified in the format:
"type1[,type2…]"
The object type must be one of the types listed in Object types.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of entities matching the keyword text and the category type, or returns an empty array.