Public API v2 → Search Catalog

About the /catalog/search endpoint

The /catalog/search endpoint searches for dashboards and folders that a user owns or has access to in the Content Manager (Catalog) and its subfolders by a defined keyword.

For information about how to get started with Public API v2, refer to References → Public API v2.

Note

You must use the HTTPS scheme to be able to successfully run the API endpoints. Additionally, you must specify the tenant name (case-sensitive) in the endpoint request URL.

Request URL

https://<cluster_URL>/incorta/api/v2/{tenantName}/catalog/search?type=<entityType>&keyword=<searchKeyword>&limit=200&offset=0

Example:

https://mycluster.incorta.com/incorta/api/v2/default/catalog/search?type=ALL&keyword=store&limit=0&offset=2

Request URL Parameters

Parameter	Type	Description	Required
tenantName	String	The tenant name (case-sensitive)	Required
type	String	Specify the type of entities you search for. Valid values are: ● ALL (default) ● DASHBOARD ● FOLDER If not defined, the endpoint returns matching dashboards and folders.	Optional
keyword	String	Specify the keyword (not case-sensitive) to search dashboard and folders names by Note: The endpoint does not account for wildcard characters. Therefore, if you use a wildcard character, such as `%`, as a keyword, the endpoint returns folders and dashboards whose names contain the specified character.	Required
limit	Integer	The maximum number of items to return, accounting for the offset you define. A valid value is any number between 1 and 2147483647 (the maximum value of an integer). The default value is 200.	Optional
offset	Integer	The number of items to skip from the matching items’ sorted list. A valid value is any number between 0 and 2147483647 (the maximum value of an integer). The default is 0.	Optional

HTTP method

GET

Request headers

{
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access_token}"
}

You must use a valid access token of a tenant user. For information about how to create an access token, refer to Public API v2 → Create an API access token.

Endpoint response

The following table shows the HTTP response status codes for this endpoint.

Code	Description	Payload Response
200	OK The endpoint successfully ran and returned the items that match the specified keyword and are owned or accessible by the user that owns the access token.	`{"resultCount": 0, "results": […]}` For more details, see Response parameters.
400	Bad Request You provided invalid values.	`{"message": "string"}` Example: `{"Parameter 'limit' parsing failed, Error: NumberFormatException, Message: For input string: \"333333333333\""}`
401	Unauthorized The endpoint couldn’t return the user’s folders and dashboards due to authentication errors, such as an invalid or expired access token.	`{"message": "string"}` Example: `{"message": "INC_09030108: Invalid authentication header. Invalid Token [abcd1234]"`
404	Not Found The tenant doesn't exist or is disabled.	`{"message": "string"}` Example: `{"message": "Invalid [DEFAULT] tenant in resource path"}`
500	Internal Server Error The endpoint couldn’t return the result list due to a server error.	`{"message": "string"}`

Response parameters

The following are the parameters in the /catalog/search endpoint response when the endpoint returns the dashboards and folders list and details successfully (code 200).

{
  "resultCount": 0,
  "results": [
        {
        "identifier": "string",         
        "name": "string",
        "ownerName": "string",
        "path": "string",
        "type": "string"
      }]
}

The following table describes these response parameters.

Parameter	Type	Description
resultCount	Integer	The total number of items that the endpoint has returned.
results	Array of objects	The matching items, whether folders or dashboards, and the details of each item
results > identifier	String	The folder’s ID or the dashboard’s GUID
results > name	String	The item name
results > ownerName	String	The name of the item’s owner
results > path	String	The path of the item. The root directory is `MYINCORTA`.
results > type	String	The item type: folder or dashboard