Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Inventory Relationships V2

Get Relationship by Type Name

Use this API to get relationship details created between entities.

get/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}

Path parameters

relationshipTypeName'Data Transfer' | 'Representative' | 'Sale of Data' | 'Destination Or Access' | 'Processor' | 'Related' | 'Controller' | 'Collection' | 'Storage Or Processing' | 'Recipient Of Sale' | 'SubProcessor' | 'Product Or Service Provider' | 'Joint Controller' | 'DirectParentChild' required
Example:Data Transfer

Relationship Type Name

relationshipIdstring uuid required
Example:4C09BF9A-38AA-45A9-87BA-77596525849E

Relationship Identifier

Response

OK

idstring uuid

Relationship ID

numberinteger

Relationship Number

deleteType'HARD' | 'SOFT' | 'NONE'

Relationship Delete Type

isContextualboolean

Is Contextual

status'APPROVED' | 'REJECTED' | 'PENDING_REVIEW' | 'NONE'

Relationship Status

attributesobject

Example response

{
  "id": "4c09bf9a-38aa-45a9-87ba-77596525849e",
  "number": 12345,
  "type": {
    "id": "2aa71ead-0c9a-416a-8471-bdfb67c8d113",
    "name": "Data Transfer",
    "nameKey": "data_transfer",
    "seeded": true,
    "schemaName": "inventory_linking",
    "moduleName": "inventory",
    "forwardRelationshipLabel": {
      "name": "sends data to",
      "isContextual": true,
      "nameKey": "sends_data_to"
    },
    "reverseRelationshipLabel": {
      "name": "receives data from",
      "isContextual": true,
      "nameKey": "receives_data_from"
    }
  },
  "deleteType": "SOFT",
  "isContextual": true,
  "status": "APPROVED",
  "attributes": {
    "dataTransferType": "Cross-Border",
    "dataTransferDate": "2025-07-21",
    "dataTransferPurpose": "Business Operations"
  }
}