Retrieve children of a specific folder — get_children_of

This function is used to obtain the children (subfolders and files) of a specified folder within a repository. It requires a path to the folder of interest.

Usage

get_children_of_folder(
  path,
  folder_uuid = NULL,
  url = getOption("integral_url"),
  page_size = getOption("integral_page_size", default = 100)
)

Arguments

path: A character string specifying the path to a folder in an Integral repository.
folder_uuid: Optional character string representing the unique identifier (UUID) of the folder. This can be used as an alternative to path. If folder_uuid is used, path will be ignored.
url: A character string representing the base URL of the Integral repository. Defaults to getOption("integral_url").
page_size: A numeric vector defining the page size or maximum number of records to be returned. The default pageSize parameter for the endpoint is `100`, this value can be increased by setting the integral_page_size in options() e.g., options("integral_page_size" = 500).

Value

A named list of items representing the children of the specified folder. The names of the list items are set to the captions of these children for easy reference. Each list element contains detailed information about the respective child item.

Details

The function constructs a specific URL using the folder UUID and sends an HTTP request to this URL. The request includes an encoded API key in the headers. The response from the server is processed to organize the children of the specified folder into a structured list, where each element contains details about a child item. The default pageSize parameter for the endpoint is `100`, this value can be increased by setting the integral_page_size in options() e.g., options("integral_page_size" = 500).

Examples

if (FALSE) { # \dontrun{

children <- get_children_of_folder(path = "R-Integral/Data/Testing")

names(children)
} # }