Opencast

UI Services REST Documentation

/admin-ng/services
This service provides the services data for the UI.

General Notes

Table of Contents

Read methods

Method / Path: GET /services.json
Description: Returns the list of services
Path params: NONE
Optional (query) params: limit(Default value=0): The maximum number of items to return per page
offset(Default value=0): The offset
filter: Filter results by name, host, actions, status or free text query
sort: The sort order. May include any of the following: host, name, running, queued, completed, meanRunTime, meanQueueTime, status. The sort suffix must be :asc for ascending sort order and :desc for descending.
Response formats: application/json
Status codes: 200: OK, Returns the list of services from Opencast
Notes:
  • Return value description: The list of services
Testing:
Sample: /services.json?limit=0&offset=0&filter={filter}&sort={sort}
Testing form (click to reveal)