--- title: "Get List of Inventories by Criteria" method: POST path: "/api/inventory/v2/inventories/{schemaName}/criteria" tags: ["Inventory"] --- # Get List of Inventories by Criteria `POST /api/inventory/v2/inventories/{schemaName}/criteria` ## Request - Base URL: `https://hostname` - URL: `https://hostname/api/inventory/v2/inventories/{schemaName}/criteria` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `INVENTORY`, `INVENTORY_READ`, `INVENTORY_WRITE` Use this API to retrieve the list of inventories for a given type by filter criteria. ## Path parameters - `schemaName` 'processing-activities' | 'vendors' | 'assets' | 'entities', required ## Query parameters - `markForDelete` boolean - `page` integer - `size` integer ## Request body - BasicInventoryFilterRequest - `filters` CriteriaDefinition[]: A list of criteria definitions to apply. All criteria in this list are typically combined with a logical AND. - `attributeKey` string: The key or path of the attribute to filter on (e.g., 'name', 'status.key', 'customFields.someCustomField'). - `dataType` integer: The data type of the attribute being filtered. (Note: Consider replacing with a more descriptive enum or String if specific integer values have meanings, e.g., 0 for String, 1 for Number, 2 for Date). For now, assuming it's an internal type identifier. - `operator` 'FilterOperator.EQUAL_TO(description=Equal To)' | 'FilterOperator.NOT_EQUAL_TO(description=Not Equal To)' | 'FilterOperator.EQ(description=Equals)' | 'FilterOperator.LT(description=LessThan)' | 'FilterOperator.GT(description=GreaterThan)' | 'FilterOperator.LE(description=LessThanOrEquals)' | 'FilterOperator.GE(description=GreaterThanOrEquals)' | 'FilterOperator.IN_BETWEEN(description=InBetween)' | 'FilterOperator.CONTAINS(description=Contains)' | 'FilterOperator.DOES_NOT_CONTAIN(description=DoesNotContain)' | 'EQUAL_TO' | 'EQ' | 'LT' | 'GT' | 'LE' | 'GE' | 'IN_BETWEEN' | 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'NOT_EQUAL_TO': The operator to use for comparing the attribute with the provided values (e.g., EQUALS, CONTAINS, GREATER_THAN). - `values` string[]: An array of string values to match against the attribute. For operators like 'IN', multiple values can be provided. For others, typically one value is used. - `date` DateDto - `fromDateValue` string, required: The start date for a date range filter, or the specific date if toDateValue is not provided or is the same. Expected format: YYYY-MM-DD. - `toDateValue` string: The end date for a date range filter. If filtering for a single day, this can be the same as fromDateValue or omitted if the operator implies a single date. Expected format: YYYY-MM-DD. ## Response `200` OK - Successfully retrieved filtered inventory list. - union - object - `data` VendorInventory[]: List of inventories - `id` string, uuid: Unique identifier of the inventory item - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `canViewDetails` boolean: Flag indicating if the current user can view inventory details - `name` string: Name of the inventory - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Risk level of the inventory - `riskScore` number: Risk score of the inventory - `status` KeyNameDto - `key` string, required: The key identifier - `name` string: The display name associated with the key - `externalId` string: External identifier of the inventory - `createdDate` string, date-time: Date and time when the inventory was created - `createdBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `updatedDate` string, date-time: Date and time when the inventory was last updated - `updatedBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `selectFields` object: Map of select fields with their values - `textFields` object: Map of text fields with their values - `number` integer: Sequence number of the inventory - `isParent` boolean: Flag indicating if this inventory is a parent - `inheritFromMaster` boolean: Flag indicating if this inventory inherits from master - `parentInventoryId` string, uuid: ID of the parent inventory - `masterRecord` string: Reference to the master record - `workflow` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `workflowStage` InventoryWorkflowStageDto - `stage` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `badgeColor` string: Color code for the workflow stage badge - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Inherent risk level of the inventory - `inherentRiskScore` number: Inherent risk score of the inventory - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Target risk level of the inventory - `targetRiskScore` number: Target risk score of the inventory - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy risk level of the inventory - `totalHierarchyRiskScore` number: Total hierarchy risk score of the inventory - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy inherent risk level of the inventory - `totalHierarchyInherentRiskScore` number: Total hierarchy inherent risk score of the inventory - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy target risk level of the inventory - `totalHierarchyTargetRiskScore` number: Total hierarchy target risk score of the inventory - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE': Type of deletion for the inventory - `deletedReason` string: Reason for deletion of the inventory - `deletedBy` string, uuid: ID of the user who deleted the inventory - `deletedDate` string, date-time: Date and time when the inventory was deleted - `isGlobalAttributeConfigurationEnabled` boolean: Flag indicating if global attribute configuration is enabled - `sourceId` string, uuid: ID of the source inventory - `integrationWorkflowId` string: ID of the integration workflow - `sourceType` string: Type of the source inventory - `reviewType` string: Type of review for the inventory - `similarRecord` SimilarRecordDetail - `id` string, uuid - `name` string - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `location` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `hasAccessToSimilarRecord` boolean - `detailsUri` string: URI for viewing the inventory details page - `redacted` string[]: Field names that should be redacted when user lacks advanced view access - `type` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `editable` boolean - `deletable` boolean - `meta` InventoriesPaginatedListResponseMeta - `page` InventoriesPaginatedListResponsePage - `first` boolean - `last` boolean - `number` integer - `size` integer - `totalElements` integer - `totalPages` integer - `sort` InventoriesPaginatedListResponseSort[]: Sort information - `direction` string - `property` string - object - `data` AssetInventory[]: List of inventories - `id` string, uuid: Unique identifier of the inventory item - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `canViewDetails` boolean: Flag indicating if the current user can view inventory details - `name` string: Name of the inventory - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Risk level of the inventory - `riskScore` number: Risk score of the inventory - `status` KeyNameDto - `key` string, required: The key identifier - `name` string: The display name associated with the key - `externalId` string: External identifier of the inventory - `createdDate` string, date-time: Date and time when the inventory was created - `createdBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `updatedDate` string, date-time: Date and time when the inventory was last updated - `updatedBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `selectFields` object: Map of select fields with their values - `textFields` object: Map of text fields with their values - `number` integer: Sequence number of the inventory - `isParent` boolean: Flag indicating if this inventory is a parent - `inheritFromMaster` boolean: Flag indicating if this inventory inherits from master - `parentInventoryId` string, uuid: ID of the parent inventory - `masterRecord` string: Reference to the master record - `workflow` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `workflowStage` InventoryWorkflowStageDto - `stage` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `badgeColor` string: Color code for the workflow stage badge - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Inherent risk level of the inventory - `inherentRiskScore` number: Inherent risk score of the inventory - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Target risk level of the inventory - `targetRiskScore` number: Target risk score of the inventory - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy risk level of the inventory - `totalHierarchyRiskScore` number: Total hierarchy risk score of the inventory - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy inherent risk level of the inventory - `totalHierarchyInherentRiskScore` number: Total hierarchy inherent risk score of the inventory - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy target risk level of the inventory - `totalHierarchyTargetRiskScore` number: Total hierarchy target risk score of the inventory - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE': Type of deletion for the inventory - `deletedReason` string: Reason for deletion of the inventory - `deletedBy` string, uuid: ID of the user who deleted the inventory - `deletedDate` string, date-time: Date and time when the inventory was deleted - `isGlobalAttributeConfigurationEnabled` boolean: Flag indicating if global attribute configuration is enabled - `sourceId` string, uuid: ID of the source inventory - `integrationWorkflowId` string: ID of the integration workflow - `sourceType` string: Type of the source inventory - `reviewType` string: Type of review for the inventory - `similarRecord` SimilarRecordDetail - `id` string, uuid - `name` string - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `location` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `hasAccessToSimilarRecord` boolean - `detailsUri` string: URI for viewing the inventory details page - `redacted` string[]: Field names that should be redacted when user lacks advanced view access - `location` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `editable` boolean - `deletable` boolean - `meta` InventoriesPaginatedListResponseMeta - `page` InventoriesPaginatedListResponsePage - `first` boolean - `last` boolean - `number` integer - `size` integer - `totalElements` integer - `totalPages` integer - `sort` InventoriesPaginatedListResponseSort[]: Sort information - `direction` string - `property` string - object - `data` EntityInventory[]: List of inventories - `id` string, uuid: Unique identifier of the inventory item - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `canViewDetails` boolean: Flag indicating if the current user can view inventory details - `name` string: Name of the inventory - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Risk level of the inventory - `riskScore` number: Risk score of the inventory - `status` KeyNameDto - `key` string, required: The key identifier - `name` string: The display name associated with the key - `externalId` string: External identifier of the inventory - `createdDate` string, date-time: Date and time when the inventory was created - `createdBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `updatedDate` string, date-time: Date and time when the inventory was last updated - `updatedBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `selectFields` object: Map of select fields with their values - `textFields` object: Map of text fields with their values - `number` integer: Sequence number of the inventory - `isParent` boolean: Flag indicating if this inventory is a parent - `inheritFromMaster` boolean: Flag indicating if this inventory inherits from master - `parentInventoryId` string, uuid: ID of the parent inventory - `masterRecord` string: Reference to the master record - `workflow` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `workflowStage` InventoryWorkflowStageDto - `stage` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `badgeColor` string: Color code for the workflow stage badge - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Inherent risk level of the inventory - `inherentRiskScore` number: Inherent risk score of the inventory - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Target risk level of the inventory - `targetRiskScore` number: Target risk score of the inventory - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy risk level of the inventory - `totalHierarchyRiskScore` number: Total hierarchy risk score of the inventory - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy inherent risk level of the inventory - `totalHierarchyInherentRiskScore` number: Total hierarchy inherent risk score of the inventory - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy target risk level of the inventory - `totalHierarchyTargetRiskScore` number: Total hierarchy target risk score of the inventory - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE': Type of deletion for the inventory - `deletedReason` string: Reason for deletion of the inventory - `deletedBy` string, uuid: ID of the user who deleted the inventory - `deletedDate` string, date-time: Date and time when the inventory was deleted - `isGlobalAttributeConfigurationEnabled` boolean: Flag indicating if global attribute configuration is enabled - `sourceId` string, uuid: ID of the source inventory - `integrationWorkflowId` string: ID of the integration workflow - `sourceType` string: Type of the source inventory - `reviewType` string: Type of review for the inventory - `similarRecord` SimilarRecordDetail - `id` string, uuid - `name` string - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `location` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `hasAccessToSimilarRecord` boolean - `detailsUri` string: URI for viewing the inventory details page - `redacted` string[]: Field names that should be redacted when user lacks advanced view access - `primaryOperatingLocation` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `editable` boolean - `deletable` boolean - `meta` InventoriesPaginatedListResponseMeta - `page` InventoriesPaginatedListResponsePage - `first` boolean - `last` boolean - `number` integer - `size` integer - `totalElements` integer - `totalPages` integer - `sort` InventoriesPaginatedListResponseSort[]: Sort information - `direction` string - `property` string - object - `data` Inventory[]: List of inventories - `id` string, uuid: Unique identifier of the inventory item - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `canViewDetails` boolean: Flag indicating if the current user can view inventory details - `name` string: Name of the inventory - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Risk level of the inventory - `riskScore` number: Risk score of the inventory - `status` KeyNameDto - `key` string, required: The key identifier - `name` string: The display name associated with the key - `externalId` string: External identifier of the inventory - `createdDate` string, date-time: Date and time when the inventory was created - `createdBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `updatedDate` string, date-time: Date and time when the inventory was last updated - `updatedBy` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `selectFields` object: Map of select fields with their values - `textFields` object: Map of text fields with their values - `number` integer: Sequence number of the inventory - `isParent` boolean: Flag indicating if this inventory is a parent - `inheritFromMaster` boolean: Flag indicating if this inventory inherits from master - `parentInventoryId` string, uuid: ID of the parent inventory - `masterRecord` string: Reference to the master record - `workflow` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `workflowStage` InventoryWorkflowStageDto - `stage` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `badgeColor` string: Color code for the workflow stage badge - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Inherent risk level of the inventory - `inherentRiskScore` number: Inherent risk score of the inventory - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Target risk level of the inventory - `targetRiskScore` number: Target risk score of the inventory - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy risk level of the inventory - `totalHierarchyRiskScore` number: Total hierarchy risk score of the inventory - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy inherent risk level of the inventory - `totalHierarchyInherentRiskScore` number: Total hierarchy inherent risk score of the inventory - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH': Total hierarchy target risk level of the inventory - `totalHierarchyTargetRiskScore` number: Total hierarchy target risk score of the inventory - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE': Type of deletion for the inventory - `deletedReason` string: Reason for deletion of the inventory - `deletedBy` string, uuid: ID of the user who deleted the inventory - `deletedDate` string, date-time: Date and time when the inventory was deleted - `isGlobalAttributeConfigurationEnabled` boolean: Flag indicating if global attribute configuration is enabled - `sourceId` string, uuid: ID of the source inventory - `integrationWorkflowId` string: ID of the integration workflow - `sourceType` string: Type of the source inventory - `reviewType` string: Type of review for the inventory - `similarRecord` SimilarRecordDetail - `id` string, uuid - `name` string - `organization` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `location` ObjectReference - `id` string, uuid - `value` string - `valueKey` string - `hasAccessToSimilarRecord` boolean - `detailsUri` string: URI for viewing the inventory details page - `redacted` string[]: Field names that should be redacted when user lacks advanced view access - `editable` boolean - `deletable` boolean - `meta` InventoriesPaginatedListResponseMeta - `page` InventoriesPaginatedListResponsePage - `first` boolean - `last` boolean - `number` integer - `size` integer - `totalElements` integer - `totalPages` integer - `sort` InventoriesPaginatedListResponseSort[]: Sort information - `direction` string - `property` string ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/revisions/daead5d9fad6?raw)