Skip to contents

This function is used to obtain meta information, e.g., fields and value options, configured with a given folder type.

Usage

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

Arguments

type

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

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 values into a structured list, where each element contains details about the available folder type values configured.

Examples

if (FALSE) { # \dontrun{
values <- get_folder_type_values(type = "Study")
} # }