Public API v2 → List Catalog Folder Content
About the /catalog/folder/{folderId} endpoint
The /catalog/folder/{folderId} endpoint lists folders and dashboards that a user owns or has access to in a specific folder in the Content Manager (Catalog).
For information about how to get started with Public API v2, refer to References → Public API v2.
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/folder/{folderId}?sortBy=<sortField>&limit=200&offset=0 `
Example:
`https://mycluster.incorta.com/incorta/api/v2/default/catalog/folder/203?sortBy=NAME_ASC&limit=200&offset=1`
Request URL Parameters
Parameter | Type | Description | Required |
---|---|---|---|
tenantName | String | The tenant name (case-sensitive) | Required |
folderId | Integer | The ID of the folder you want to list its content | 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 folder 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]" |
403 | Unauthorized The endpoint couldn’t return the content list as the user with the access token does not have access rights to view the specified folder. | {"message": "string"} Example: {"message": "INC_02010000: You are not authorized to VIEW the FOLDER of ID [209]"} |
404 | Not Found The tenant doesn't exist or is disabled, or the specified folder does not exist. | {"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/folder/{folderId} 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 specified folder |
results | Array of objects | The folder’s contents, whether sub-folders or dashboards, and the details of each item |
results > identifier | String | The sub-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 specified folder 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) |
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
{"path": "MYINCORTA/Examples/OnlineStore","results": [{"identifier": "5l91xffe-3x79-406a-ao9e-6138700019e0","name": "About","ownerName": "System Administrator","type": "DASHBOARD"},{"identifier": "203","name": "Annual Reports","ownerName": "Analyst User","type": "FOLDER"}],"resultCount": 2}