Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
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}

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

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"
  }
}