Sign in

v1

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

Get List of Inventories by Criteria

Use this API to retrieve the list of inventories for a given type by filter criteria.

post/api/inventory/v2/inventories/{schemaName}/criteria

Path parameters

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

The name property of the schema.

Query parameters

markForDeleteboolean

Flag to include soft-deleted inventories.

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page (1..50)

Request body

Example request

{
  "filters": [
    {
      "attributeKey": "name",
      "operator": "CONTAINS",
      "values": [
        "Server"
      ]
    },
    {
      "attributeKey": "status.key",
      "operator": "EQUALS",
      "values": [
        "active"
      ]
    }
  ]
}

Response

OK - Successfully retrieved filtered inventory list.

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"
    }
  ],
  "meta": {
    "page": {
      "first": true,
      "last": true,
      "size": 20,
      "totalElements": 1,
      "totalPages": 1,
      "sort": [
        {
          "direction": "ASC",
          "property": "name"
        }
      ]
    }
  }
}