v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Inventory Relationships V2

Create Relationship

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

post/api/inventory-linking/v1/inventories/relations

Request body

attributesobject

Custom Attributes based on schema defined for given link type

linkTypeNamestring required

Link type identifier

linkTypeLabelstring required

Link type label

Example request

{
  "sourceInventory": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  },
  "targetInventory": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  },
  "contextProcess": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Sample Entity Name"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  }
}

Response

Relationship created successfully

string uuid required