Get list of root folders from a repository — get_root

This function retrieves a list of root folders from a specific repository, identified by the provided URL. It makes an HTTP request to a server endpoint to fetch this information.

Usage

get_root_folders(
  url = getOption("integral_url"),
  page_size = getOption("integral_page_size", default = 100)
)

Arguments

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 where each element corresponds to a root folder in the specified repository. The list's names are set to the captions of the folders for easy reference. Each list element is an object containing details about the folder.

Details

The function sends a request to a predefined URL with an encoded API key included in the request headers. The server's response is processed to extract information about each root folder. The names of the folders (captions) are used to name the elements of the returned list for easier access.

Examples

if (FALSE) { # \dontrun{
# Assuming you have a valid Integral URL:
root_folders <- get_root_folders()
} # }