1. Home
  2. Previous Releases
  3. Latest Release
  4. Guides
  5. Concepts
  6. Tools
  7. References
    1. Apache Spark
    2. Built-in Functions
    3. Incorta Component SDK
    4. Incorta Connector SDK
    5. Connectors
    6. Data Studio
    7. Public API
      1. Public API v2
        1. Create External Schema
        2. Extract to External Table
        3. Append to External Table
        4. Delete External Table
        5. Delete External Schema
        6. List Catalog Content
        7. List Catalog Folder Content
        8. Search Catalog Content
        9. Create Catalog Folder
        10. Get SQLi Connectiont
        11. Schedule Dashboard Report
        12. Dashboard Prompts
        13. Rename & Move Dashboards
        14. Insight Query
        15. Execute Load Plan
        16. Load Plan Execution Status
        17. Query a Business View
        18. Load Schema
        19. Schema Status
        20. List Schemas
        21. List Schema Objects
        22. Reset Passwords
        23. Transfer Ownership
    8. Security
    9. SQL Interface
    10. Visualizations
    11. Other
  8. Integrations
  9. Data applications
  10. Releases
  11. Incorta Premium

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

Use the HTTPS or HTTP scheme according to your installation. You must use the HTTPS scheme to successfully run the API endpoints on Cloud installations.

Request URL

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

Examples:

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

Request URL Parameters

ParameterTypeDescriptionRequired
tenantNameStringThe tenant name (case-sensitive)Required
typeStringSpecify 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
keywordStringSpecify 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
limitIntegerThe 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
offsetIntegerThe 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.

CodeDescriptionPayload Response
200OK
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.
400Bad Request
You provided invalid values.		{"message": "string"}
Example:
{"Parameter 'limit' parsing failed, Error: NumberFormatException, Message: For input string: \"333333333333\""}
401Unauthorized
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]"
404Not Found
The tenant doesn't exist or is disabled.		{"message": "string"}
Example:
{"message": "Invalid [DEFAULT] tenant in resource path"}
500Internal 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.

ParameterTypeDescription
resultCountIntegerThe total number of items that the endpoint has returned.
resultsArray of objectsThe matching items, whether folders or dashboards, and the details of each item
results > identifierStringThe folder’s ID or the dashboard’s GUID
results > nameStringThe item name
results > ownerNameStringThe name of the item’s owner
results > pathStringThe path of the item. The root directory is MYINCORTA.
results > typeStringThe item type: folder or dashboard
Note

If any of the returned string fields, such as the dashboard name, contains a backslash \, the returned value will contain an additional backslash symbol. For example, a dashboard with the name My\Dashboard will be returned as My\\Dashboard.

Response example

{
  "resultCount": 2,
  "results": [
        {
        "identifier": "4b7xcd90-23av-4add-922b-040ads4e00e ",
        "name": "CTO Demo",
        "ownerName": "System Administrator",
        "path": "MYINCORTA/Demos/CTO Demo",
        "type": "DASHBOARD"
      },
        {
        "identifier": "205",
        "name": "Demos",
        "ownerName": " System Administrator ",
        "path": "MYINCORTA/Demos",
        "type": "FOLDER"
      }]
}