Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Catalog Search V2

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. This API is designed to return large volumes of catalog search results.

🗒 Things to Know

  • The continuationToken parameter returned in the response can be used on a subsequent API call to retrieve the next set of catalog search results. For more information, see Understanding & Implementing Pagination.
post/api/data-governance/v2/catalog/search

Headers

x-onetrust-continuationTokenstring

Continuation Token available in Search Response to retrieve next page.

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

continuationTokenstring

Token for continuing the search from where it left off

Example response

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