Skip to contents

This function is used to obtain a list of configured folder type attributes associated with an Integral repository and folder type name.

Usage

get_folder_type_attributes(type, url = getOption("integral_url"))

Arguments

type

A character string specifying the type of folder, e.g., "Study".

url

A character string representing the base URL of the Integral repository. Defaults to getOption("integral_url").

Value

An unnamed list of items representing the attributes of given folder type.

Details

The function constructs a specific URL and sends an HTTP request to this endpoint. The request includes an encoded API key in the header. The response from the server is processed to organize the folder type attributes into a structured list, where each element contains details about the available folder type attributes configured.

Examples

if (FALSE) { # \dontrun{
attributes <- get_folder_type_attributes(type = "Study")
} # }