GET /v1/searchByCategory - 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 category.

Parameters

Name Description
category

Location: query

Type: string

The entity category to be searched. This must be one of the entity categories listed in Entity categories.
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.

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.