Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Incidents

Link Incident to Inventory

Use this API to link an incident with a specific inventory type.

post/incident/v1/incidents/{incidentId}/inventory-links/{inventoryType}

Path parameters

incidentIdstring uuid required

Incident ID

inventoryType'assets' | 'processing-activities' | 'vendors' | 'entities' required

Type of inventory being linked. Allowed values: {assets, processing-activities, vendors, entities}

Request body

inventoryIdsstring[]

Inventory Identifiers

externalIdsstring[]

Set of unique identifiers for the record from an external system

sourceType'MANUAL' | 'ASSESSMENT' | 'INTEGRATION'

Example request

{
  "inventoryIds": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ],
  "externalIds": [
    "EXT-12345",
    "EXT-67890"
  ],
  "sourceType": "INTEGRATION"
}

Response

Inventory links successfully created

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

Type of the associated inventory

idstring uuid

Unique identifier of the associated inventory

namestring

Name of the associated inventory

Example response

{
  "inventoryType": "assets",
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Customer Data Asset",
  "organization": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Organization Name"
  }
}