Rlabkey: labkey.security.moveContainer – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

labkey.security.moveContainer

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 `baseUrl` for the labkey server.
`folderPath`	A string specifying the `folderPath` to be moved. Additionally, the container entity id is also valid.
`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

Examples

library(Rlabkey)

labkey.security.moveContainer(baseUrl="http://labkey/", folderPath = "/home/FolderToMove",
    destinationParent = "/OtherProject", addAlias = TRUE
)

Rlabkey

Data Exchange Between R and 'LabKey' Server

v2.6.0

Apache License 2.0

Authors

Peter Hussey

Initial release

2021-02-02