labkey.security.renameContainer: Rename an existing container at the given container path

In Rlabkey: Data Exchange Between R and 'LabKey' Server

Rename an existing container at the given container path

Description

Renames an existing container at the given container path. This action allows for updating the container name, title, or both.

Usage

labkey.security.renameContainer(baseUrl=NULL, folderPath,
    name=NULL, title=NULL, addAlias=TRUE)

Arguments

baseUrl	A string specifying the baseUrl for the labkey server.
folderPath	A string specifying the folderPath to be renamed. Additionally, the container entity id is also valid.
name	The new container name. If not specified, the container name will not be changed.
title	The new container title. If not specified, the container name will be used.
addAlias	Add alias of current container path for the current container name (defaults to true).

Details

This function renames an existing container at the given container path on the LabKey server. A new container name and/or title must be specified. If a new name is provided but not a title, the name will also be set as the container title.

Value

Returns a success message for the container rename action.

Author(s)

Cory Nathe

See Also

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

Examples

## Not run: 

library(Rlabkey)

labkey.security.renameContainer(baseUrl="http://labkey/", folderPath = "/home/OriginalFolder",
    name = "NewFolderName", title = "New Folder Title", addAlias = TRUE
)


## End(Not run)

Rlabkey documentation built on Oct. 23, 2024, 5:06 p.m.