ONonetrust
Object Relationship Management

Create Relationship Record between Objects

Use this API to create a new Relationship Record between objects.

🗒 Things to Know

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

Request

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

Query parameters

linkTypeIdstring uuid required

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

The unique identifier of the relationship type.

Request body

attributesobject

This parameter can be used to store attribute details in key value pairs.

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

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.