GET /v1/getLinkedEntitiesByUDL - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0

Description

Return an array of JSON objects detailing entities currently linked by a given UDL type, with an optional parameter to qualify results by source or destination entity ID.

Parameters

Name Description
getLinkedEntitiesByUdlJson

Location: query

Type: string

A JSON string containing the user-defined link type name (linkType) and optionally a database object ID for the source or destination entity (entityID). If the entity ID is provided, all user-defined links matching both the type name and entity ID will be returned. If an entity ID is not provided, all user-defined links matching the type name will be returned. For an example of the JSON string, refer to Get linked entities by user-defined link.

Responses

Code Description
200

Type: Array of integer

Returns an array of JSON objects, each representing a user-defined link.