Data Types

ListFolderResponse

Response body for ListFolderDescendants.

Structure

Example

{
"cursor": "/uploads/file.jpg",
"folder": {
"folderPath": "/uploads",
"settings": {
"description": "This is an example folder description.",
"publicPermissions": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
],
"storageLayer": {
"type": "InternalStorageV2"
}
},
"status": "Deleting",
"type": "Folder"
},
"items": [
{
"filePath": "/uploads/image.jpg",
"fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
"lastModified": 1615680311115,
"size": 43182,
"type": "File"
}
]
}

Properties

cursor

Cursor that must be provided to the next request (to continue reading the next page of results).

If null is returned or the response cursor equals the request cursor, then paging has completed.

Type: String | Null

Min Length: 1

Max Length: 512

Example: "/uploads/file.jpg"

Required: Yes

folder

Summary information about the requested folder.

Type: FolderSummary

Required: Yes

items

Summary information about each of the folder's descendants (files and folders).

Type: ObjectSummary[]

Required: Yes

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: