FolderListRequest Data Type

Request object for a request to list folders

Properties
name data type description
id string Get id
nodeId number Get nodeId
skipCount number Get skipCount
maxItems number Get maxItems
recursive boolean Get recursive
sortBy string Get sortBy
sortOrder string Get sortOrder
inherited boolean Get inherited
search string Get search
editor string Get editor
creator string Get creator
editedBefore number Get editedBefore
editedSince number Get editedSince
createdBefore number Get createdBefore
createdSince number Get createdSince
tree boolean Get tree
recursiveIds array of string Get recursiveIds
addPrivileges boolean Get addPrivileges
privilegeMap boolean True for adding privilege maps to the folders
wastebin WastebinSearch exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects

Example

{
  "id" : "...",
  "nodeId" : 12345,
  "skipCount" : 12345,
  "maxItems" : 12345,
  "recursive" : true,
  "sortBy" : "...",
  "sortOrder" : "...",
  "inherited" : true,
  "search" : "...",
  "editor" : "...",
  "creator" : "...",
  "editedBefore" : 12345,
  "editedSince" : 12345,
  "createdBefore" : 12345,
  "createdSince" : 12345,
  "tree" : true,
  "recursiveIds" : [ "...", "..." ],
  "addPrivileges" : true,
  "privilegeMap" : true,
  "wastebin" : "include"
}