Rlabkey (version 3.3.0)

labkey.security.getContainers: Returns information about the specified container

Description

Returns information about the specified container, including the user's current permissions within that container. If the includeSubfolders config option is set to true, it will also return information about all descendants the user is allowed to see.

Usage

labkey.security.getContainers(baseUrl=NULL, folderPath,
    includeEffectivePermissions=TRUE, includeSubfolders=FALSE, depth=50,
    includeChildWorkbooks=TRUE, includeStandardProperties = TRUE)

Value

The data frame containing the container properties for the current folder and subfolders, including name, title, id, path, type, folderType, and effectivePermissions.

Arguments

baseUrl

A string specifying the baseUrl for the labkey server.

folderPath

A string specifying the folderPath.

includeEffectivePermissions

If set to false, the effective permissions for this container resource will not be included (defaults to true).

includeSubfolders

If set to true, the entire branch of containers will be returned. If false, only the immediate children of the starting container will be returned (defaults to false).

depth

May be used to control the depth of recursion if includeSubfolders is set to true.

includeChildWorkbooks

If true, include child containers of type workbook in the response (defaults to TRUE).

includeStandardProperties

If true, include the standard container properties like title, formats, etc. in the response (defaults to TRUE).

Author

Cory Nathe

Details

This function returns information about the specified container, including the user's current permissions within that container. If the includeSubfolders config option is set to true, it will also return information about all descendants the user is allowed to see. The depth of the results for the included subfolders can be controlled with the depth parameter.

See Also

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

Examples

if (FALSE) {

library(Rlabkey)

labkey.security.getContainers(
    baseUrl="http://labkey/", folderPath = "home",
    includeEffectivePermissions = FALSE, includeSubfolders = TRUE, depth = 2,
    includeChildWorkbooks = FALSE, includeStandardProperties = FALSE
)

}