v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Object Relationship Type Management

Get Relationship Type

Use this API to retrieve the details of a single Relationship Type by its unique identifier.

🗒 Things to Know

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

get/v1/entity-link-types/{entityLinkTypeId}

Path parameters

entityLinkTypeIdstring uuid required

Unique identifier (UUID) of the relationship type to retrieve

This flag indicates whether the object type is seeded.

Response

OK - Returns the complete details of the requested relationship type

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 type's relationship to the source object type used for translation purposes.

enableAuditboolean

This flag indicates whether audit activity is enabled.

allowNewCustomLinkAssociationboolean

This flag indicates whether new custom relationship links are allowed.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Vendor-Product",
  "nameKey": "entity.link.vendor_product",
  "description": "Links between vendors and their products",
  "descriptionKey": "entity.link.vendor_product.description",
  "displayName": "Vendor Product Relationship",
  "displayNameKey": "entity.link.vendor_product.display",
  "entityType1Id": "789e4567-e89b-12d3-a456-426614174123",
  "entityType1Name": "Vendor",
  "entityType2Id": "456e4567-e89b-12d3-a456-426614174789",
  "entityType2Name": "Product",
  "entityType1ToEntityType2EntityLinkName": "Vendor provides Product",
  "entityType1ToEntityType2EntityLinkNameKey": "entity.link.vendor_to_product",
  "entityType2ToEntityType1EntityLinkName": "Product belongs to Vendor",
  "entityType2ToEntityType1EntityLinkNameKey": "entity.link.product_to_vendor",
  "enableAudit": true,
  "allowNewCustomLinkAssociation": false,
  "auditFields": {
    "createdBy": "john.doe@example.com",
    "createdTimestamp": "2025-01-15T10:30:45Z",
    "lastModifiedBy": "jane.smith@example.com",
    "lastModifiedTimestamp": "2025-06-10T14:15:22Z"
  }
}