FolderListRequest Data Type

Request object for a request to list folders

Properties
name data type constraints description
id string   Get id
nodeId number   Get nodeId
skipCount number required int Get skipCount
maxItems number required int Get maxItems
recursive boolean required 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 required int Get editedBefore
editedSince number required int Get editedSince
createdBefore number required int Get createdBefore
createdSince number required int Get createdSince
tree boolean required boolean Get tree
recursiveIds array of string   Get recursiveIds
addPrivileges boolean required boolean Get addPrivileges
privilegeMap boolean required 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
stagingPackageName string   Get staging package name to check the folder staging status upon

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" : "only",
  "stagingPackageName" : "..."
}