Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Relationship Management

Create Relationship Record between Entities

Use this API to create a new 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.
post/api/ai-governance/v1/links

Query parameters

linkTypeIdstring uuid required

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

Request body

attributesobject

Custom Attributes based on schema defined for given link type

Example request

{
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "entity1": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "number": 1024,
    "name": "OneTrust DataGuidance",
    "isDeleted": false,
    "detailsAccessRestricted": false,
    "redirectURL": "/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "entityType": {
      "id": "d1119953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Product",
      "displayName": "Product",
      "nameKey": "entity.type.product",
      "displayNameKey": "entity.type.product.display",
      "module": "VENDOR"
    },
    "linkEntityDetail": {
      "includeCustomFields": true,
      "includeStandardFields": true
    }
  },
  "entity2": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "number": 1024,
    "name": "OneTrust DataGuidance",
    "isDeleted": false,
    "detailsAccessRestricted": false,
    "redirectURL": "/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "entityType": {
      "id": "d1119953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Product",
      "displayName": "Product",
      "nameKey": "entity.type.product",
      "displayNameKey": "entity.type.product.display",
      "module": "VENDOR"
    },
    "linkEntityDetail": {
      "includeCustomFields": true,
      "includeStandardFields": true
    }
  }
}

Response

Created - The relationship was successfully established

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