ONonetrust
Relationship Management

Get Relationship Record

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

🗒 Things to Know

  • This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
  • AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
get/api/ai-governance/v1/links/{linkId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/ai-governance/v1/links/{linkId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: AI_GOVERNANCE, AI_GOVERNANCE_READ, AI_GOVERNANCE_WRITE

Path parameters

linkIdstring uuid required

Identifier of the link record

Unique identifier of the link record to retrieve

Query parameters

linkTypeIdstring uuid required

Unique identifier of the link type to use for getting the relationship

Response

OK - Returns the complete details of the requested relationship

idstring uuid required

Unique identifier of the link record. Auto-generated when a new link is created.

schemaIdstring uuid

Unique identifier of the schema used for this link type.

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.