Get Folder Tree
DescriptionThis API returns folders associated to given entitlement and user. This is similar to view folder tree on Customer Connect License-Management or Users-Permissions page.
Request
URLURL
Path Parameters
Path Parameters
Entitlement Account for which folders are required.
entAccount example
12345678
Query Parameters
Query Parameters
Name of the folder to search
folderName example
"myFolder"
No. of folders to get in this request. By default, first 50 folders will be sent.
length example
50
folder id of which all the sub folders are required
navigatingFolderId example
1111111
Optional start value for this folder tree request. Default is 0.
start example
0
Header Parameters
Header Parameters
Bearer Access Token Generated using API Key
Authorization example
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
Authentication
Response
Response BodyResponse Body
200 OK
Folder tree returned successfully.
{
"folderTimeStamp": "2022-02-01T17:15:21.652Z",
"recordsFiltered": 1,
"recordsTotal": 10
}
Current timestamp when folder details are generated
Number of folders present in current response
Total number of folders present for given Entitlement Account
Errors
Either request is not valid or input validation has failed.
Access Token is not valid or expired.
Server error while getting the details.
