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.

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

Path parameters

idstring uuid required

The unique identifier of an inventory record. The value can be obtained using the List Inventories API.

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

idstring uuid required

The unique identifier of the inventory record to link to

entityTypestring

The type of the inventory entity

Example request

[
  {
    "relation": "JointControllerLinkType",
    "id": "d31425ae-1321-4738-bb76-bdca83c0944c",
    "entityType": "vendors"
  }
]

Response

OK

inventoryIdstring uuid

The unique identifier of the linked inventory record

inventoryAssociationIdstring uuid

The unique identifier of the association between inventory records

Example response

[
  {
    "inventoryId": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
    "inventoryAssociationId": "4374d5da-44ac-4308-a298-3efdb0f34ba4"
  }
]