Public API v2 → List Catalog Content

About the /catalog endpoint

The /catalog endpoint lists folders and dashboards that a user owns or has access to in the root directory of the Content Manager (Catalog).

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/{tenant}/catalog?sortBy=<sortField>&limit=200&offset=0

Example:

https://mycluster.incorta.com/incorta/api/v2/default/catalog?sortBy=NAME_ASC&limit=200&offset=10

Request URL Parameters

Parameter	Type	Description	Required
tenantName	String	The tenant name (case-sensitive)	Required
sortBy		The sorting field and order of the content list (case-sensitive). Valid values are: ● NAME_ASC (default) ● NAME_DESC ● OWNER_ASC ● OWNER_DESC ● MODIFICATION_DATE_ASC ● MODIFICATION_DATE_DESC	Optional
limit	Integer	The maximum number of items to return from the sorted list, accounting for the offset value 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 sorted list before returning the result 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 Catalog content that the user owns or has access to.	`{"path": "string", "results": […], "resultCount": 0}` 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	Unauthenticated 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 content list due to a server error.	`{"message": "string"}`

Response parameters

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

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

The following table describes these response parameters.

Parameter	Type	Description
path	String	The path of the Catalog’s root directory; that is, `MYINCORTA`
results	Array of objects	An array of the Catalog contents, 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 > type	String	The item type: folder or dashboard
resultCount	Integer	The total number of items in the Catalog’s root directory that the owner of the access token owns or has access to, regardless of the number of items the endpoint has returned (does not account for the limit or offset values)