General

GET /api/events

Returns a list of events.

The following query string parameters are supported to filter, sort and pagingate the returned list:

Query String Parameter	Type	Description
filter	string	A comma-separated list of filters to limit the results with (see Filtering). See the below table for the list of available filters
sort	string	A comma-separated list of sort criteria (see Sorting). See the below table for the list of available sort criteria
limit	integer	The maximum number of results to return (see Pagination)
offset	integer	The index of the first result to return (see Pagination)

The following filters are available:

Filter Name	Description
contributors	Events where the contributors match
location	Events based upon the location it is scheduled in
series	Events based upon which series they are a part of
subject	Filters events based upon which subject they are a part of
textFilter	Filters events where any part of the event's metadata fields match this value

The list can be sorted by the following criteria:

Sort Criteria	Description
title	By the title of the event
presenter	By the presenter of the event
start_date	By the start date of the event
end_date	By the end date of the event
review_status	By whether the event has been reviewed and approved or not
workflow_state	By the current processing state of the event. Is it scheduled to be recorded (INSTANTIATED), currently processing (RUNNING), paused waiting for a resource or user paused (PAUSED), cancelled (STOPPED), currently failing (FAILING), already failed (FAILED), or finally SUCCEEDED
scheduling_status	By the current scheduling status of the event
series_name	By the series name of the event
location	By the location (capture agent) that the event will be or has been recorded on

This request additionally supports the following query string parameters to include additional information directly in the response:

Query String Parameter	Type	Description
sign	boolean	Whether public distribution urls should be signed
withacl	boolean	Whether the acl metadata should be included in the response
withmetadata	boolean	Whether the metadata catalogs should be included in the response
withpublications	boolean	Whether the publication ids and urls should be included in the response

By setting the optional sign parameter to true, the method will pre-sign distribution urls if URL signing is turned on in Opencast. Remember to consider the maximum validity of signed URLs when caching this response.

Sample request

https://opencast.example.org/api/events?sort=title:DESC&limit=5&offset=1&filter=location:ca-01

Response

200 (OK): A (potentially empty) list of events is returned. The list is represented as JSON array where each element is a JSON object with the following fields:

Field	Type	Description
identifier	string	The unique identifier of the event
creator	string	The technical creator of this event
presenter*	array[string]	The presenters of this event
created	datetime	The date and time this event was created
subjects*	array[string]	The subjects of this event
start	datetime	The technical start date and time of this event
description*	string	The description of this event
title*	string	The title of this event
processing_state	string	The current processing state of this event
duration	string	The bibliographic duration of this event
archive_version	string	The current version of this event
contributor*	array[string]	The contributors of this event
has_previews	boolean	Whether this event can be opened with the video editor
location*	string	The bibliographic location of this event
publication_status	array[string]	The publications available for this event

* Metadata fields of metadata catalog dublincore/episode

Example

[
  {
    "identifier": "776d4970-bc2d-45c4-900a-1f80b7990cb8",
    "creator": "Opencast Project Administrator",
    "presenter": [
      "Prof. X",
      "Dr. Who"
    ],
    "created": "2018-03-19T16:11:48Z",
    "subjects": [
      "Mathematics",
      "Basics"
    ],
    "start": "2018-03-19T16:11:48Z",
    "description": "This lecture is about the very basics",
    "title": "Lecture 1 - The Basics",
    "processing_state": "SUCCEEDED",
    "duration": 0,
    "archive_version": 3,
    "contributor": [
      "Prof. X"
    ],
    "has_previews": true,
    "location": "",
    "publication_status": [
      "internal",
      "engage-player",
      "api",
      "oaipmh-default"
    ]
  },
  {
    "identifier": "2356d450-b42d-94xd-2a0d-3fa04745c0cb8",
    "creator": "Opencast Project Administrator",
    "presenter": [
    ],
    "created": "2018-04-20T09:38:42Z",
    "subjects": [
      "Physics"
    ],
    "start": "2018-04-23T08:00:00Z",
    "description": "The forces explained",
    "title": "Lecture 8 - Advanced stuff",
    "processing_state": "SUCCEEDED",
    "duration": 0,
    "archive_version": 2,
    "contributor": [
    ],
    "has_previews": true,
    "location": "",
    "publication_status": [
      "internal",
      "engage-player",
      "api",
      "oaipmh-default"
    ]
  }
]

POST /api/events

Creates an event by sending metadata, access control list, processing instructions and files in a multipart request.

Multipart Form Parameters	Type	Description
acl	acl	A collection of roles with their possible action
metadata	catalogs	Event metadata as Form param
presenter	file	Presenter movie track
presentation	file	Presentation movie track
audio	file	Audio track
processing	string	Processing instructions task configuration

Sample

metadata:

[
  {
    "flavor": "dublincore/episode",
    "fields": [
      {
        "id": "title",
        "value": "Captivating title"
      },
      {
        "id": "subjects",
        "value": ["John Clark", "Thiago Melo Costa"]
      },
      {
        "id": "description",
        "value": "A great description"
      },
      {
        "id": "startDate",
        "value": "2016-06-22"
      },
      {
        "id": "startTime",
        "value": "13:30:00Z"
      }
    ]
  }
]

processing:

{
  "workflow": "schedule-and-upload",
  "configuration": {
    "flagForCutting": "false",
    "flagForReview": "false",
    "publishToEngage": "true",
    "publishToHarvesting": "true",
    "straightToPublishing": "true"
  }
}

acl:

[
  {
    "action": "write",
    "role": "ROLE_ADMIN"
  },
  {
    "action": "read",
    "role": "ROLE_USER"
  }
]

Response

201 (CREATED): A new event is created and its identifier is returned in the Location header.
400 (BAD REQUEST): The request is invalid or inconsistent.

Location: http://api.opencast.org/api/events/e6aeb8df-a852-46cd-8128-b89de696f20e

{
  "identifier": "e6aeb8df-a852-46cd-8128-b89de696f20e"
}

GET /api/events/{event_id}

Returns a single event.

By setting the optional sign parameter to true, the method will pre-sign distribution urls if signing is turned on in Opencast. Remember to consider the maximum validity of signed URLs when caching this response.

Query String Parameter	Type	Description
sign	boolean	Whether public distribution urls should be signed.
withacl	boolean	Whether the acl metadata should be included in the response.
withmetadata	boolean	Whether the metadata catalogs should be included in the response.
withpublications	boolean	Whether the publication ids and urls should be included in the response.

Response

200 (OK): The event is returned as JSON object with the following fields:

Field	Type	Description
identifier	string	The unique identifier of the event
creator	string	The technical creator of this event
presenter*	array[string]	The presenters of this event
created	datetime	The date and time this event was created
subjects*	array[string]	The subjects of this event
start	datetime	The technical start date and time of this event
description*	string	The description of this event
title*	string	The title of this event
processing_state	string	The current processing state of this event
duration	string	The bibliographic duration of this event
archive_version	string	The current version of this event
contributor*	array[string]	The contributors of this event
has_previews	boolean	Whether this event can be opened with the video editor
location*	string	The bibliographic location of this event
publication_status	array[string]	The publications available for this event

* Metadata fields of metadata catalog dublincore/episode

404 (NOT FOUND): The specified event does not exist.

{
  "identifier": "776d4970-bc2d-45c4-900a-1f80b7990cb8",
  "creator": "Opencast Project Administrator",
  "presenter": [
    "Prof. X",
    "Dr. Who"
  ],
  "created": "2018-03-19T16:11:48Z",
  "subjects": [
    "Mathematics",
    "Basics"
  ],
  "start": "2018-03-19T16:11:48Z",
  "description": "This lecture is about the very basics",
  "title": "Lecture 1 - The Basics",
  "processing_state": "SUCCEEDED",
  "duration": 0,
  "archive_version": 3,
  "contributor": [
    "Prof. X"
  ],
  "has_previews": true,
  "location": "",
  "publication_status": [
    "internal",
    "engage-player",
    "api",
    "oaipmh-default"
  ]
}

POST /api/events/{event_id}

Updates an event.

Multipart Form Parameters	Type	Description
acl	acl	A collection of roles with their possible action
metadata	catalogs	Event metadata as Form param
presenter	file	Presenter movie track
presentation	file	Presentation movie track
audio	file	Audio track
processing	string	Processing instructions task configuration

Sample

This sample request will update the Dublin Core metadata section of the event only.

metadata:

[
  {
    "flavor": "dublincore/episode",
    "fields": [
      {
        "id": "title",
        "value": "Captivating title"
      },
      {
        "id": "subjects",
        "value": ["Space", "Final Frontier"]
      },
      {
        "id": "description",
        "value": "A great description"
      }
    ]
  }
]

Response

204 (NO CONTENT): The event has been updated.
404 (NOT FOUND): The specified event does not exist.

DELETE /api/events/{event_id}

Deletes an event.

Response

204 (NO CONTENT): The event has been deleted.
404 (NOT FOUND): The specified event does not exist.

Access Policy

Most events in Opencast come with an access control list (ACL), containing entries that map actions to roles, either allowing or denying that action.

The section on roles in the chapter on Authorization will help shed some light on what kind of roles are available and how they are assigned to the current user.

For more information about access control lists, please refer to Access Control Lists.

GET /api/events/{event_id}/acl

Returns an event's access policy.

Response

200 (OK): The access control list for the specified event is returned as acl.
404 (NOT FOUND): The specified event does not exist.

[
  {
    "allow": true,
    "action": "write",
    "role": "ROLE_ADMIN"
  },
  {
    "allow": true,
    "action": "read",
    "role": "ROLE_USER"
  }
]

PUT /api/events/{event_id}/acl

Update an event's access policy.

Form Parameters	Type	Description
acl	acl	Access policy

Note that the existing access control list will be overwritten.

Sample

acl:

[
  {
    "allow": true,
    "action": "write",
    "role": "ROLE_ADMIN"
  },
  {
    "allow": true,
    "action": "read",
    "role": "ROLE_USER"
  }
]

Response

204 (NO CONTENT): The access control list for the specified event is updated.
404 (NOT FOUND): The specified event does not exist.

POST /api/events/{event_id}/acl/{action}

Grants permission to execute action on the specified event to any user with role role. Note that this is a convenience method to avoid having to build and post a complete access control list.

Path Parameters	Type	Description
event_id	string	Event identifier
action	string	The action that is allowed to be executed

Form Parameters	Type	Description
role	string	The role that is granted permission

Note that other access control lists entries will not be affected by this request.

Sample

role: "ROLE_STUDENT"

Response

204 (NO CONTENT): The permission has been created in the access control list of the specified event.
404 (NOT FOUND): The specified event does not exist.

DELETE /api/events/{event_id}/acl/{action}/{role}

Revokes permission to execute action on the specified event from any user with role role.

Path Parameters	Type	Description
event_id	string	Event identifier
action	string	The action that is no longer allowed to be executed
role	string	The role that is no longer granted permission

Note that other access control lists entries will not be affected by this request.

Response

204 (NO CONTENT): The permission has been revoked from the access control list of the specified event.
404 (NOT FOUND): The specified event does not exist.

Metadata

This section describes how to use the External API to work with metadata catalogs associated to events.

Opencast manages the bibliographic metadata of series using metadata catalogs which are identified by flavors. The default metadata catalog for Opencast events has the flavor dublincore/episode. Opencast additionally supports extended metadata catalogs for series that can be configured.

The External API supports both the default event metadata catalog and events extended metadata catalogs. For the default event metadata catalog, the metadata is directly returned in the responses.

Since the metadata catalogs can be configured, the External API provides a facility to retrieve the catalog configuration of series metadata catalogs. For more details about this mechanism, please refer to "Metadata Catalogs".

GET /api/events/{event_id}/metadata

Returns the complete set of metadata.

Response

200 (OK): The metadata collection is returned as catalogs.
404 (OK): The specified event does not exist.

[
  {
    "label": "EVENTS.EVENTS.DETAILS.CATALOG.EPISODE",
    "flavor": "dublincore/episode",
    "fields": [
      {
        "id": "title",
        "readOnly": false,
        "value": "Captivating title",
        "label": "EVENTS.EVENTS.DETAILS.METADATA.TITLE",
        "type": "text",
        "required": true
      },
      {
        "id": "description",
        "readOnly": false,
        "value": "A great description",
        "label": "EVENTS.EVENTS.DETAILS.METADATA.DESCRIPTION",
        "type": "text_long",
        "required": false
      }
    ]
  },
  {
    "label": "EVENTS.EVENTS.DETAILS.CATALOG.LICENSE",
    "flavor": "license/episode",
    "fields": [
      {
        "id": "license",
        "readOnly": false,
        "value": "CCND",
        "label": "EVENTS.EVENTS.DETAILS.METADATA.LICENSE",
        "collection": {
          "BSD": "EVENTS.LICENSE.BSD",
          "GPL3": "EVENTS.LICENSE.GPL",
          "CCND": "EVENTS.LICENSE.CCND"
        },
        "type": "text",
        "required": false
      }
    ]
  }
]

GET /api/events/{event_id}/metadata

Returns the event's metadata of the specified type. For a metadata catalog there is the flavor such as dublincore/episode and this is the unique type.

Query String Parameters	Type	Description
type	flavor	The type of metadata to get

Response

200 (OK): The metadata collection is returned as fields.
404 (NOT FOUND): The specified event does not exist.

[
  {
    "id": "title",
    "readOnly": false,
    "value": "Captivating title",
    "label": "EVENTS.EVENTS.DETAILS.METADATA.TITLE",
    "type": "text",
    "required": true
  },
  {
    "id": "description",
    "readOnly": false,
    "value": "A great description",
    "label": "EVENTS.EVENTS.DETAILS.METADATA.DESCRIPTION",
    "type": "text_long",
    "required": false
  }
]

PUT /api/events/{event_id}/metadata

Update the metadata with the matching type of the specified event. For a metadata catalog there is the flavor such as dublincore/episode and this is the unique type.

Query String Parameters	Type	Description
type	flavor	The type of metadata to update

Form Parameters	Type	Description
metadata	values	Metadata fields and values to be updated

Note that metadata fields not included in the form parameter metadata will not be updated.

Sample

metadata:

[
  {
    "id": "title",
    "value": "Captivating title"
  },
  {
    "id": "subjects",
    "value": ["Space", "Final Frontier"]
  },
  {
    "id": "description",
    "value": "A great description"
  }
]

Response

204 (NO CONTENT): The metadata of the given namespace has been updated.
400 (BAD REQUEST): The request is invalid or inconsistent.
404 (NOT FOUND): The specified event does not exist.

DELETE /api/events/{event_id}/metadata

Delete the metadata namespace catalog of the specified event. This will remove all fields and values of the catalog.

Query String Parameters	Type	Description
type	flavor	The type of metadata to delete

Note that the metadata catalog of type dublincore/episode cannot be deleted.

Response

204 (NO CONTENT): The metadata of the given namespace has been updated.
403 (FORBIDDEN): The main metadata catalog dublincore/episode cannot be deleted as it has mandatory fields.
404 (NOT FOUND): The specified event does not exist.

Publications

GET /api/events/{event_id}/publications

Returns an event's list of publications.

Response

200 (OK): The list of publications is returned.
404 (NOT FOUND): The specified event does not exist.

[
  {
    "id":"publication-1",
    "channel":"engage",
    "mediatype":"text/html",
    "url":"http://engage.opencast.org/engage/ui/player.html?id=123"
  },
  {
    "id":"publication-2",
    "channel":"oaipmh",
    "mediatype":"text/html",
    "url":"http://oaipmh.opencast.org/default/?verb=GetRecord&id=123"
  }
]

GET /api/events/{event_id}/publications/{publication_id}

Returns a single publication.

Response

200 (OK): The track details are returned.
404 (NOT FOUND): The specified event does not exist.
404 (NOT FOUND): The specified publication does not exist.

{
  "id":"publication-1",
  "channel":"engage",
  "mediatype":"text/html",
  "url":"http://engage.opencast.org/engage/ui/player.html?id=123",
  "media":[
    {
      "id":"track-1",
      "mediatype":"video/mp4",
      "url":"http://download.opencast.org/123/presenter.mp4",
      "flavor":"presenter/delivery",
      "size":84938490,
      "checksum":"58308405383094",
      "tags":[

      ],
      "has_audio":true,
      "has_video":true,
      "duration":3648,
      "description":"Video: h264 (Constrained Baseline) (avc1 / 0x31637661), yuv420p, 640x360, 447 kb/s, 25 fps, 25"
    },
    {
      "id":"track-2",
      "mediatype":"audio/aac",
      "url":"http://download.opencast.org/123/presenter.m4a",
      "flavor":"presenter/audio",
      "size":9364,
      "checksum":"839478372",
      "tags":[

      ],
      "has_audio":true,
      "has_video":false,
      "duration":3648,
      "description":"aac (mp4a / 0x6134706D), 44100 Hz, stereo, fltp, 96 kb/s (default)"
    }
  ],
  "attachments":[
    {
      "id":"attachment-1",
      "mediatype":"image/png",
      "url":"http://download.opencast.org/123/preview.png",
      "flavor":"presenter/preview",
      "size":62728,
      "checksum":"389475737",
      "tags":[

      ]
    }
  ],
  "metadata":[
    {
      "id":"catalog-1",
      "mediatype":"text/xml",
      "url":"http://download.opencast.org/123/dublincore.xml",
      "flavor":"dublincore/episode",
      "size":364,
      "checksum":"18498498383",
      "tags":[

      ]
    }
  ]
}