General Notes
- All paths above are relative to the REST endpoint base (something like http://your.server/files)
- If the service is down or not working it will return a status 503, this means the the underlying service is not working and is either restarting or has failed
- A status code 500 means a general failure has occurred which is not recoverable and was not anticipated. In other words, there is a bug! You should file an error report with your server logs from the time when the error occurred: Opencast Issue Tracker
Table of Contents
Read methods
| Method / Path: | GET /groups.{format:xml|json} |
|---|---|
| Description: | Returns a list of groups |
| Path params: | format: The output format (json or xml) of the response body. |
| Optional (query) params: |
limit(Default value=100):
The maximum number of items to return per page. offset(Default value=0): The page number. |
| Response formats: |
text/xml
application/json |
| Status codes: | 200: OK, The groups. |
| Notes: |
|
| Testing: |
Sample:
/groups.{format:xml|json}?limit=100&offset=0
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST / |
|---|---|
| Description: | Add a group |
| Path params: | NONE |
| Required (form) params: | name: The group name |
| Optional (form) params: |
description:
The group description roles: A comma seperated string of additional group roles users: A comma seperated string of group members |
| Status codes: |
201: Created, Group created 400: Bad Request, Name too long 403: Forbidden, Not enough permissions to create a group with the admin role. 409: Conflict, An group with this name already exists. |
| Notes: |
|
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{id} |
|---|---|
| Description: | Remove a group |
| Path params: | id: The group identifier |
| Optional (query) params: | NONE |
| Status codes: |
200: OK, Group deleted 403: Forbidden, Not enough permissions to remove a group with the admin role. 404: Not Found, Group not found. 500: Internal Server Error, An internal server error occured. |
| Notes: |
|
| Testing: |
Sample:
/{id}
Testing form (click to reveal)
|
| Method / Path: | PUT /{id} |
|---|---|
| Description: | Update a group |
| Path params: | id: The group identifier |
| Required (form) params: |
name: The group name
users: A comma seperated string of group members |
| Optional (form) params: |
description:
The group description roles: A comma seperated string of additional group roles |
| Status codes: |
200: OK, Group updated 403: Forbidden, Not enough permissions to update a group with the admin role. 404: Not Found, Group not found 400: Bad Request, Name too long |
| Notes: |
|
| Testing: |
Sample:
/{id}
Testing form (click to reveal)
|