[\x00-\x1F]
. Thus in full folder paths, consecutive characters of "/" will be interpreted as a single character "/", and trailing characters of "/" will be ignored. Folders can be renamed, moved, and removed./class-xxxx/newFolder
folder
string The new folder to be created in the data containerparents
boolean (optional, default false) Whether the parentid
string ID of the manipulated data containerfolder
is missing or is not a nonempty string starting with "/", or parents
is present but is not a boolean) parents
is false but the parent folder of the folder specified in folder
does not yet exist) parents
was not set to true) /class-xxxx/renameFolder
folder
string Folder to be renamedname
string The new basename of the folder (to replace thefolder
)id
string ID of the manipulated data containerfolder
is missing or is not a nonempty string starting with "/", folder
is "/", name
is missing or is not a nonempty string with no "/") /class-xxxx/listFolder
includeHidden
is set to true.folder
string (optional, default "/") The folder to be listeddescribe
boolean or mapping (optional, default false) False indicates that no extra metadata should be retrieved with the data object results. A mapping represents the input that would be used for calling the result's corresponding describe method; the value true is equivalent to the empty hash input.only
string (optional, default "all") Indicate what type of contents to return; one of the values "folders", "objects", or "all"includeHidden
boolean (optional, default false) Whether hidden objects should be returned in objects
; applicable only if only
is set to "objects" or "all".hasSubfolderFlags
boolean (optional, default false) Indicate whether a folder has subfoldersobjects
array of mappings List of metadata for all data objects in the specified folder, each with the key/values:id
string The object IDdescribe
was set to true or a mapping:describe
mapping The output of the result's corresponding describe methodfolders
array of strings or array of arrays By default, this is a list of all folders directly under the specified folder. If the 'hasSubfolderFlags' input is set to true, the array will contain arrays of exactly two elements where the first element is a string of the folder name and the second element is a boolean that is set to true if the folder has subfolders and false otherwise.folder
is not a nonemptyonly
is given but is not one ofincludeHidden
is present but is/class-xxxx/removeFolder
recurse
is set to true. Note that removing the root folder "/" with recurse
set to true removes ALL of the contents in the data container. Setting recurse
to true should be used carefully to prevent accidental deletion of data. Removing a folder removes all of the visible objects contained in it and all of their orphaned hidden links. Any remaining hidden objects that are not removed by this process are placed in the root folder. In particular, if recurse
is false and the folder to be removed only contains hidden objects, then these objects are similarly placed in the root folder, and the specified folder folder
is removed.partial
to true to allow for a partial removal of the folder's contents up to this limit. A completed
flag will then be set in the output to indicate whether or not the folder was completely removed. If completed
is set to false, reissue the api call with the partial
flag in order to continue removing the folder.folder
string The folder to be removed from the data containerrecurse
boolean (optional, default false) Whether removal shouldforce
boolean (optional, default false) If true, this operation shouldpartial
boolean (optional, default false) If true, this operation willid
string ID of the manipulated data containerpartial
was set to true:completed
boolean True if all objects, subfolders, and the specifiedfolder
is missing, folder
is not set to a nonempty string starting with "/", folder
is set to "/" but recurse
is not specified or is false, recurse
is provided and is not a boolean) force
was not set to true recurse
is false and the specified folder contains either subfolders or visible objectspartial
is false and the specified folder contains more objects than/class-xxxx/move
folders
remain in the (moved) folder unless explicitly listed in objects
or folders
as well, in which case they are removed from their parent folder and moved to the destination folder described in folder
. In addition, any objects explicitly listed in objects
will pull along hidden objects that they also link to into the folder indicated as destination
.objects
array of strings (optional) List of data object IDs tofolders
array of strings (optional) List of folders to bedestination
string The destination folderid
string ID of the manipulated data containerobjects
(if provided) is not an array of nonempty strings, folders
(if provided) is not an array of nonempty strings starting with "/", two of the folders in folders
have the same name but different paths, destination
is missing or is not a nonempty string starting with "/") folders
is or contains the destination folder) /class-xxxx/removeObjects
objects
array of strings List of object IDs to be removed from the data containerforce
boolean (optional, default false) If true, this operation should not throw an error even if the given object does not existid
string ID of the manipulated data containerobjects
is missing or is not an array of nonempty strings) force
was not set to true