ONonetrust
inventory-management-controller

Get Inventory Identifiers

Use this API to retrieve a paginated list of inventory identifiers for a given type with advanced filtering capabilities.

Example Request

POST https://{hostname}/api/inventory/v2/inventories/{type}/identifiers

POST https://trial.onetrust.com/api/inventory/v2/inventories/vendors/identifiers

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

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/inventories/{schemaName}/identifiers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_READ, INVENTORY_WRITE

Path parameters

schemaNamestring required

Query parameters

pageinteger
sizeinteger
sortstring[]
orgGroupIdstring uuid
traversalstring
filterByIdboolean
generatorstring
searchTextstring

Request body

filterCriteriaobject

A map of filter criteria, where the key is a logical operator (AND, OR) and the value is a list of criteria definitions. This allows for building complex queries.

searchTextstring

A simple text string to search across multiple relevant fields of an inventory item. Used for quick search functionality.

searchOnNumberboolean

Indicates if the searchText should specifically target numeric fields. Default is false.

Example request

{
  "filterCriteria": {
    "AND": [
      {
        "fieldName": "name",
        "operator": "CONTAINS",
        "value": "Server"
      },
      {
        "fieldName": "status.key",
        "operator": "EQUALS",
        "value": "active"
      }
    ]
  },
  "searchText": "Mainframe Alpha"
}

Response

OK - Successfully retrieved inventory identifiers.

string required

Changes

No recorded changes to this operation across all 1 revision of this API.