Rlabkey (version 3.3.0)

labkey.security.deleteContainer: Deletes an existing container, which may be a project, folder, or workbook

Description

Deletes an existing container, which may be a project, folder, or workbook, and all of its children from the Labeky server.

Usage

labkey.security.deleteContainer(baseUrl=NULL, folderPath)

Value

Returns a success message for the container deletion action.

Arguments

baseUrl

A string specifying the baseUrl for the labkey server.

folderPath

A string specifying the folderPath to be deleted.

Author

Cory Nathe

Details

This function allows for users with proper permissions to delete an existing container, which may be a project, folder, or workbook, from the LabKey server. This will also remove all subfolders of the container being deleted. If the container does not exist or the user does not have permissions, an error message will be returned.

See Also

labkey.getFolders, labkey.security.getContainers, labkey.security.createContainer, labkey.security.moveContainer labkey.security.renameContainer

Examples

if (FALSE) {

library(Rlabkey)

labkey.security.deleteContainer(baseUrl="http://labkey/", folderPath = "/home/FolderToDelete")

}