Sign in

v1

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

Link Inventory

Use this API to create a bidirectional link between an inventory and one or more other inventories.

put/api/inventory/v2/inventories/{id}/relations

Path parameters

idstring uuid required

The unique identifier of an inventory record

Query parameters

entityType'processing-activities' | 'vendors' | 'assets' | 'entities'

Entity type parameter

Request body

relation'ControllerLinkType' | 'JointControllerLinkType' | 'RelatedLinkType' | 'RecipientOfSaleLinkType' | 'SubProcessorLinkType' | 'ProcessorLinkType' | 'DestinationAccessLinkType' | 'ProductOrServiceProviderLinkType' | 'StorageProcessingLinkType' | 'SourceCollectionLinkType'

The type of relationship between inventory records

InventoryType'processing-activities' | 'vendors' | 'assets' | 'entities' required
Idsstring[] required

Example request

[
  {
    "relation": "JointControllerLinkType",
    "InventoryType": "vendors",
    "Ids": [
      "a1087fcb-1058-40ba-8c36-43dfafc0bba8",
      "f9d7a8f1-af0d-418e-9092-e860307a48a3"
    ]
  }
]

Response

OK