Returns a list of groups.

oc_list_groups(filter = "", sort = "", limit = 0, offset = 0)

Arguments

filter

A comma seperated list of filters to limit the results with. A filter is the filter's name followed by a colon ":" and then the value to filter with so it is the form :.

sort

Sort the results based upon a list of comma seperated sorting criteria. In the comma seperated list each type of sorting is specified as a pair such as: :ASC or :DESC. Adding the suffix ASC or DESC sets the order as ascending or descending order and is mandatory.

limit

The maximum number of results to return for a single request.

offset

The index of the first result to return.

Value

Returns a list of groups.

Details

This function expects the hostname, username and password to be set as environment variables.

Examples

Sys.setenv(OPENCAST_HOST = "https://legacy.opencast.org") Sys.setenv(OPENCAST_USERNAME = "admin") Sys.setenv(OPENCAST_PASSWORD = "opencast") oc_list_groups()
#> $content #> list() #> #> $url #> [1] "https://legacy.opencast.org/api/groups/" #> #> $response #> Response [https://legacy.opencast.org/api/groups/?filter=&sort=&limit=0&offset=0] #> Date: 2020-03-19 11:21 #> Status: 200 #> Content-Type: application/v1.2.0+json #> Size: 2 B #> <BINARY BODY> #> #> attr(,"class") #> [1] "opencast_api"