v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Relationship Management

Create Relationship

Use this API to create a Relationship Record between inventories (Assets, Vendors, Processing Activities, and Entities).

post/api/inventory-linking/v1/relationship

Request body

additionalFieldsobject

Additional non attribute details associated with relationship

attributesobject

Custom And Base Attributes

Example request

{
  "entity1": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  },
  "entity2": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  },
  "relationshipLabel": {
    "relationshipTypeRequest": {
      "relationshipTypeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
    }
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  }
}

Response

Relationship successfully created

string uuid required

UUID of the created relationship

Example response

"4c09bf9a-38aa-45a9-87ba-77596525849e"