labkey.security.moveContainer {Rlabkey} | R Documentation |
Moves an existing container, which may be a folder or workbook
Description
Moves an existing container, which may be a folder or workbook, to be the subfolder of another folder and/or project on the LabKey server.
Usage
labkey.security.moveContainer(baseUrl=NULL, folderPath,
destinationParent, addAlias = TRUE)
Arguments
baseUrl |
A string specifying the |
folderPath |
A string specifying the |
destinationParent |
The container path of destination parent. Additionally, the destination parent entity id is also valid. |
addAlias |
Add alias of current container path to container that is being moved (defaults to true). |
Details
This function moves an existing container, which may be a folder or workbook, to be the subfolder of another folder and/or project on the LabKey server. Projects and the root container can not be moved. If the target or destination container does not exist or the user does not have permissions, an error message will be returned.
Value
Returns a success message for the container move action with the new path.
Author(s)
Cory Nathe
See Also
labkey.getFolders
,
labkey.security.getContainers
,
labkey.security.createContainer
,
labkey.security.deleteContainer
labkey.security.renameContainer
Examples
## Not run:
library(Rlabkey)
labkey.security.moveContainer(baseUrl="http://labkey/", folderPath = "/home/FolderToMove",
destinationParent = "/OtherProject", addAlias = TRUE
)
## End(Not run)