ONonetrust
Object Relationship Management

Get Relationship Record

Use this API to retrieve the details of a specific Relationship Record between objects.

🗒 Things to Know

  • This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
get/v1/links/{linkId}

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/v1/links/{linkId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: OBJECT_MANAGER, OBJECT_MANAGER_READ, OBJECT_MANAGER_WRITE

Path parameters

linkIdstring uuid required

Unique identifier of the link record to retrieve

The unique identifier of the relationship record.

Query parameters

linkTypeIdstring uuid required

Unique identifier of the link type

The unique identifier of the relationship type.

Response

OK - Returns the complete details of the requested relationship

idstring uuid required

The unique identifier of the relationship record.

schemaIdstring uuid

The unique identifier of the schema.

Example response

{
  "id": "d1119953-b4b5-4042-8cb9-b78038cc4c46",
  "linkType": {
    "name": "Related"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.