Return an array of objects detailing entities currently linked by a given UDL type, with an optional parameter to qualify results by source or destination entity ID.
API method:
GET
/v1/getLinkedEntitiesByUDL
Example
Input:
{ "linkType": "UniqueLinkTypeName", "entityId": 100895 }
Output:
[ { "sourceId": 100895, "description": "Description for the link", "destinationId": 100897 }, { "sourceId": 100895, "description": "Description for the link", "destinationId": 100904 } ]
Parameters
- linkType—enter a unique name for the user-defined link.
- entityId—(optional) enter the source or destination entity ID. If an ID is not provided, all linked entities matching the specified link type will be returned.
Note:
- If providing an entityId parameter, you must provide either the source entity ID, or the destination entity ID, but not both.
- You cannot retrieve a name that is a reserved link type name. For a list of reserved link type names, refer to Reference: Reserved link type names.