ONonetrust
Catalog Search V1

Get Catalog Search Results

Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms.

🗒 Things to Know

post/api/data-governance/v1/catalog/search

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/data-governance/v1/catalog/search
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DATA_CATALOG_READ

Request body

searchTextstring

Text to search for

searchFieldsstring[]
facetsstring[]
selectFieldsstring[]
partialSearchboolean

Whether to perform partial text matching

Example request

{
  "searchText": "data privacy",
  "filterCriteria": {
    "criteriaGroups": [
      {
        "criteria": [
          {
            "searchField": "name",
            "operator": "EQ",
            "value": "Table123",
            "values": {
              "from": "61",
              "to": "80"
            },
            "multiValue": [
              "EmployeeId"
            ],
            "dateUnitType": "DAYS",
            "searchFieldDataType": "string",
            "searchMode": "ALL",
            "searchQueryType": "SIMPLE",
            "multiValueRanges": [
              {
                "from": "61",
                "to": "80"
              }
            ]
          }
        ]
      }
    ]
  },
  "searchFields": [
    "description"
  ],
  "facets": [
    "documentType"
  ],
  "selectFields": [
    "description"
  ]
}

Response

OK

facetsobject

Faceted search results grouped by field

Example response

{
  "documents": {
    "data": [
      {
        "id": "172a829d-0f9f-45ab-b5f5-028d228c6edf",
        "documentType": "metadata",
        "name": "Employee table",
        "jobId": "234a829d-0f9f-45ab-b5f5-028d228abcd",
        "source": "data-discovery"
      }
    ]
  }
}

Changes

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