GET /v1/getLinkedEntities - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Description

Returns an array of entities containing the entities linked to a specified entity. The array is empty if there are no linked entities.
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.
entityId

Location: query

Type: integer (int64)

The object ID of the entity for which to return linked entities.
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 linked entities which need to be returned. This value must be one of the types listed in Object types.
Note:
  • While specifying a resource record as the entityId, if you want to find all the records CNAME, MX, or SRV records having links to this record, you can use RecordWithLink for the type parameter.
  • When specifying a MAC address as the entityId, this method returns the IPv4 address associated with the MAC address. When appropriate, leaseTime and expiryTimeinformation also appears in the returned properties string.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of entities. The array is empty if there are no linked entities.