Sign in

v1

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

Get Inventory by External ID

Use this API to retrieve the inventory by external ID.

get/api/inventory/v2/inventories/{schemaName}/reference/{externalId}

Path parameters

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

The name property of the schema. The value can be obtained using the Get Schemas API.

externalIdstring required

The external identifier of the inventory item.

Response

OK - Successfully retrieved inventory by external ID.

OR
OR
OR

Example response

{
  "data": {
    "id": "96214230-ffbb-4870-b6c4-0f30c3bfec60",
    "canViewDetails": true,
    "name": "Vendor XYZ",
    "riskLevel": "HIGH",
    "riskScore": 8.5,
    "status": {
      "key": "active",
      "name": "Active"
    },
    "externalId": "EXT-12345",
    "createdDate": "2023-01-15T10:30:45.123Z",
    "updatedDate": "2023-02-20T14:15:30.456Z",
    "selectFields": {
      "data-residency": [
        {
          "key": "us",
          "value": "US"
        }
      ]
    },
    "textFields": {
      "description": "Sample description"
    },
    "number": 123,
    "isParent": true,
    "inheritFromMaster": true,
    "parentInventoryId": "96214230-ffbb-4870-b6c4-0f30c3bfec60",
    "masterRecord": "MASTER-001",
    "workflowStage": {
      "badgeColor": "#4CAF50"
    },
    "inherentRiskLevel": "MEDIUM",
    "inherentRiskScore": 6.5,
    "targetRiskLevel": "LOW",
    "targetRiskScore": 3,
    "totalHierarchyRiskLevel": "HIGH",
    "totalHierarchyRiskScore": 8,
    "totalHierarchyInherentRiskLevel": "MEDIUM",
    "totalHierarchyInherentRiskScore": 6,
    "totalHierarchyTargetRiskLevel": "LOW",
    "totalHierarchyTargetRiskScore": 3,
    "inventoryDeleteType": "SOFT",
    "deletedReason": "No longer required",
    "deletedBy": "ab0b11d9-8ba2-46f3-b845-2ca50bef4efc",
    "deletedDate": "2023-03-01T12:00:00.000Z",
    "isGlobalAttributeConfigurationEnabled": true,
    "sourceId": "c79fb1a9-9406-4e9b-bff7-c72e635ee82b",
    "integrationWorkflowId": "wf-123",
    "sourceType": "API_INTEGRATION",
    "reviewType": "ANNUAL"
  }
}