[{"label":"Latest (1.0)","version":"latest"}]
customer-connect

Get Folder Tree

Description

This 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

Request

URL

URL


get
https://apigw.vmware.com/v1/m4/api/myvmware/entitlements/accounts/{entAccount}/folders
Copy

Path Parameters

Path Parameters

string
entAccount Required

Entitlement Account for which folders are required.


Query Parameters

Query Parameters

string
folderName Optional

Name of the folder to search

folderName example
map[code:"myFolder"
]

integer
length Optional

No. of folders to get in this request. By default, first 50 folders will be sent.

length example
map[code:50
]

string
navigatingFolderId Optional

folder id of which all the sub folders are required

navigatingFolderId example
map[code:1111111
]

integer
start Optional

Optional start value for this folder tree request. Default is 0.

start example
map[code:0
]

Header Parameters

Header Parameters

string
Authorization Required

Bearer Access Token Generated using API Key

Authorization example
map[code:"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
]

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns FolderTreeResponse of type application/json

Folder tree returned successfully.

{
	"folderContents": [
		{
			"folderAccess": "VIEW",
			"folderId": "11111111.000000",
			"folderLevel": 2,
			"folderName": "myFolder",
			"folderType": "USER",
			"fullFolderPath": "HOME\\myFolder",
			"hasSubFolders": true,
			"parentFolderId": 1,
			"permissions": {
				"divComb": false,
				"manage": true,
				"upgDwg": false,
				"view": true
			},
			"rootFolderId": 1
		}
	],
	"folderTimeStamp": "2022-02-01T17:15:21.652Z",
	"recordsFiltered": 1,
	"recordsTotal": 10
}
array of Folder
folderContents Optional

Folder Details such as folder name, folder path etc.


string as date-time
folderTimeStamp Optional

Current timestamp when folder details are generated


integer as int64
recordsFiltered Optional

Number of folders present in current response


integer as int64
recordsTotal Optional

Total number of folders present for given Entitlement Account

Errors

Errors

400

Either request is not valid or input validation has failed.


401

Access Token is not valid or expired.


500

Server error while getting the details.

Code Samples

Code Samples

cURL Command

curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" https://apigw.vmware.com/v1/m4/api/myvmware/entitlements/accounts/{entAccount}/folders


[{"label":"Latest (1.0)","version":"latest"}]
customer-connect
Feedback

Was this page helpful?