Opencast

Editor Service Endpoint REST Documentation

/editor
This is the editor service.

Table of Contents

Read methods

Method / Path: GET /{mediaPackageId}/edit.json
Description: Returns all the information required to get the editor tool started
Path params: mediaPackageId: The id of the media package
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Media package found
404: Not Found, Media package not found
Notes:
  • Return value description: JSON object
Testing:
Sample: /{mediaPackageId}/edit.json
Testing form (click to reveal)
Method / Path: GET /{mediaPackageId}/metadata.json
Description: Returns all the data related to the metadata tab in the event details modal as JSON
Path params: mediaPackageId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event metadata tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event metadata tab as JSON
Testing:
Sample: /{mediaPackageId}/metadata.json
Testing form (click to reveal)

Write methods

Method / Path: POST /{mediaPackageId}/edit.json
Description: Takes editing information from the client side and processes it
Path params: mediaPackageId: The id of the media package
Optional (form) params: NONE
Status codes: 200: OK, Editing information saved and processed
404: Not Found, Media package not found
400: Bad Request, The editing information cannot be parsed
Testing:
Sample: /{mediaPackageId}/edit.json
Testing form (click to reveal)
Method / Path: POST /{mediaPackageId}/lock
Description: Creates and updates the lock for a mediapackage in the editor. Requests will create/refreshen a lock at /editor/{mediapackageId}/lock{uuid} (see Location header in response) that will expire after the configured period. Subsequent calls must have the same uuid, which will then freshen the lock.
Path params: mediaPackageId: The id of the media package
Required (form) params: user: The user requesting to lock this mediapackage
uuid: The unique identitier of the lock
Optional (form) params: NONE
Status codes: 201: Created, Lock obtained
409: Conflict, Lock not obtained
404: Not Found, Mediapackage not found
Notes:
  • Return value description: The lock is returned in the Location header.
Testing:
Sample: /{mediaPackageId}/lock
Testing form (click to reveal)
Method / Path: DELETE /{mediaPackageId}/lock/{uuid}
Description: Releases the lock for a mediapackage in the editor
Path params: mediaPackageId: The id of the media package
uuid: Identifier of editor session
Optional (query) params: NONE
Status codes: 200: OK, Lock deleted
409: Conflict, Lock not obtained
404: Not Found, Lock not found
Testing:
Sample: /{mediaPackageId}/lock/{uuid}
Testing form (click to reveal)