opencastR (version 0.1.3)

oc_list_workflow_definitions: Query Opencast for the list of workflow definitions

Description

Returns a list of workflow definition.

Usage

oc_list_workflow_definitions(
  withoperations = FALSE,
  withconfigurationpanel = FALSE,
  filter = "",
  sort = "",
  limit = 0,
  offset = 0
)

Arguments

withoperations

Whether the workflow operations should be included in the response.

withconfigurationpanel

Whether the workflow configuration panel should be included in the response.

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 workflow definition.

Details

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

Examples

# NOT RUN {
Sys.setenv(OPENCAST_HOST = "https://legacy.opencast.org")
Sys.setenv(OPENCAST_USERNAME = "admin")
Sys.setenv(OPENCAST_PASSWORD = "opencast")

oc_list_workflow_definitions()
# }