---
title: "Get Relationship Record"
method: GET
path: "/api/ai-governance/v1/links/{linkId}"
tags: ["Relationship Management"]
---

# Get Relationship Record

`GET /api/ai-governance/v1/links/{linkId}`

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.

## Path parameters

- `linkId` string, uuid, required — Identifier of the link record

## Query parameters

- `linkTypeId` string, uuid, required

## Response `200`

OK - Returns the complete details of the requested relationship

- LinkInformation
  - `id` string, uuid, required — Unique identifier of the link record. Auto-generated when a new link is created.
  - `linkType` IdOrNameLinkType, required
    - `id` string, uuid — Unique Identifier of an Link Type
    - `name` string — Name of an Link Type
    - `idOrNamePresent` boolean
  - `linkTypeLabel` BasicLinkTypeLabelInformation
    - `id` integer, required — Pk of an Link Type Object Type Pair
    - `entityType1ToEntityType2EntityLinkName` string — Link type name from EntityType1-EntityType2
    - `entityType2ToEntityType1EntityLinkName` string — Link type name from EntityType2-EntityType1
  - `entity1` LinkedEntityInformation, required
    - `linkEntityDetail` EntityDetailRequest
      - `extendedBaseAttributes` object — Base Seeded Attributes
    - `id` string, uuid, required — Unique identifier of the entity
    - `number` integer, required — Auto-generated sequential entity number
    - `name` string — Name of the entity
    - `detailsAccessRestricted` boolean — Flag indicating whether entity is view-only
    - `redirectURL` string — Redirect URL for the entity
    - `entityType` BasicEntityTypeInformation, required
      - `id` string, uuid, required — The unique identifier for the entity type.
      - `name` string, required — The name of the entity type.
      - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
      - `moduleName` string — The name of the module where the entity exists.
      - `schemaName` string — The name of the schema.
    - `deleted` boolean
  - `entity2` LinkedEntityInformation, required
    - `linkEntityDetail` EntityDetailRequest
      - `extendedBaseAttributes` object — Base Seeded Attributes
    - `id` string, uuid, required — Unique identifier of the entity
    - `number` integer, required — Auto-generated sequential entity number
    - `name` string — Name of the entity
    - `detailsAccessRestricted` boolean — Flag indicating whether entity is view-only
    - `redirectURL` string — Redirect URL for the entity
    - `entityType` BasicEntityTypeInformation, required
      - `id` string, uuid, required — The unique identifier for the entity type.
      - `name` string, required — The name of the entity type.
      - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
      - `moduleName` string — The name of the module where the entity exists.
      - `schemaName` string — The name of the schema.
    - `deleted` boolean
  - `schemaId` string, uuid — Unique identifier of the schema used for this link type.
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required — The date and time that the entity was last created.
    - `lastUpdatedDate` string, date-time — The date and time that the entity was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)