FolderListResponse Data Type

Response for a folder list request.

Properties
name data type description
deleted array of string List of folderIds (or [nodeId/folderId]s), which were requested to be opened (when getting folder structures), but do not exist in the backend (at least not visible for the user)
Properties inherited from AbstractListResponse
items array of object Items in the list
hasMoreItems boolean True if more items are available to get (if paging was used)
numItems number Get total number of items available
perms map of array of Permission User permissions on the returned items, if applicable and requested
Properties inherited from StagingResponse
stagingStatus map of StagingStatus Staging status of contained objects
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

{
  "deleted" : [ "...", "..." ],
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "translatepages", "importitems" ],
    "property2" : [ "createform", "update" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}