v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Object Relationship Type Management

Create Relationship Type between Objects

Use this API to create a new Relationship Type between two object types.

🗒 Things to Know

This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

post/v1/entity-link-types

Request body

namestring required

The name of the relationship type.

descriptionstring

The description of the relationship type.

entityType1ToEntityType2EntityLinkNamestring

The name of the source object type's relationship to the target object type.

entityType2ToEntityType1EntityLinkNamestring

The name of the target object type's relationship to the source object type.

Example request

{
  "name": "Product/Service",
  "description": "Defined link between Vendor and Product/Service",
  "linkAssociations": [
    {
      "entityType1": {
        "name": "Vendors"
      },
      "entityType2": {
        "name": "Assets"
      }
    },
    {
      "entityType1": {
        "name": "Vendors"
      },
      "entityType2": {
        "name": "Vendors"
      }
    }
  ],
  "entityType1ToEntityType2EntityLinkName": "OneTrust provides GRC",
  "entityType2ToEntityType1EntityLinkName": "GRC belongs to OneTrust"
}

Response

Created - The relationship type has been successfully created

idstring uuid required

The unique identifier of the relationship type.

namestring required

The name of the relationship type.

nameKeystring

The name key of the relationship type used for translation purposes.

seededboolean

This flag indicates whether the relationship type is seeded.

moduleNamestring

The name of the product where the relationship type exists.

descriptionstring

The description of the relationship type.

descriptionKeystring

The description key of the relationship type used for translation purposes.

entityType1ToEntityType2EntityLinkNamestring

The name of the source object type's relationship to the target object type.

entityType1ToEntityType2EntityLinkNameKeystring

The name key of the source object type's relationship to the target object type used for translation purposes.

entityType2ToEntityType1EntityLinkNamestring

The name of the target object type's relationship to the source object type.

entityType2ToEntityType1EntityLinkNameKeystring

The name key of the target object types's relationship to the source object type.

enableAuditboolean

This flag indicates whether audit activity is enabled.

allowNewCustomLinkAssociationboolean

This flag indicates whether new relationship links are allowed.

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "name": "Product/Service",
  "nameKey": "link.type.productservice.name",
  "seeded": true,
  "moduleName": "CustomEntityManagement",
  "description": "Links between vendors and their products",
  "descriptionKey": "entity.link.vendor_product.description",
  "entityType1ToEntityType2EntityLinkName": "Vendor provides Product",
  "entityType1ToEntityType2EntityLinkNameKey": "entity.link.vendor_to_product",
  "entityType2ToEntityType1EntityLinkName": "Product belongs to Vendor",
  "entityType2ToEntityType1EntityLinkNameKey": "entity.link.product_to_vendor",
  "enableAudit": true,
  "auditFields": {
    "createdBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    },
    "lastModifiedBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    }
  },
  "linkAssociations": [
    {
      "id": 999,
      "entityType1": {
        "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
        "name": "Asset"
      },
      "entityType2": {
        "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
        "name": "Asset"
      },
      "enabled": true,
      "seeded": true,
      "auditFields": {
        "createdBy": {
          "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
          "name": "Name"
        },
        "lastModifiedBy": {
          "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
          "name": "Name"
        }
      }
    }
  ]
}