GET /v1/getEntityByName - BlueCat Address Manager

GET /v1/getEntityByName - BlueCat Address Manager - 9.2.0

Address Manager API Guide

Locale

English (United States)

Product name

BlueCat Address Manager

Version

9.2.0

Returns an object from the database referenced by its name field.

Name	Description
name	Location: query Type: string The name of the target object.
parentId	Location: query Type: integer (int64) The ID of the target object’s parent object. Note: Starting in Address Manager API v9.2.0, this parameter is now required.
type	Location: query Type: string The type of object returned by the method. This string must be one of the constants listed in Object types.

Name

Description

name

Location: query

Type: string

The name of the target object.

parentId

Location: query

Type: integer (int64)

The ID of the target object’s parent object.

Note: Starting in Address Manager API v9.2.0, this parameter is now required.

type

Location: query

Type: string

The type of object returned by the method. This string must be one of the constants listed in Object types.

Code	Description
200	Type: APIEntity Returns an object that matches the name. If there are multiple objects matching the name, the method returns the first in the list. An object with null values is returned if there are no matching objects.