Opencast

Event Service REST Documentation

/admin-ng/event
Provides resources and operations related to the events

General Notes

Table of Contents

Read methods

Method / Path: GET /{eventId}/asset/assets.json
Description: Returns the number of assets from each types as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the number of assets from each types as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The number of assets from each types as JSON
Testing:
Sample: /{eventId}/asset/assets.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/attachment/{id}.json
Description: Returns the details of an attachment from the given event and attachment id as JSON
Path params: eventId: The event id
id: The attachment id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the details of an attachment from the given event and attachment id as JSON
404: Not Found, No event or attachment with this identifier was found.
Notes:
  • Return value description: The details of an attachment from the given event and attachment id as JSON
Testing:
Sample: /{eventId}/asset/attachment/{id}.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/attachment/attachments.json
Description: Returns a list of attachments from the given event as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns a list of attachments from the given event as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The list of attachments from the given event as JSON
Testing:
Sample: /{eventId}/asset/attachment/attachments.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/catalog/{id}.json
Description: Returns the details of a catalog from the given event and catalog id as JSON
Path params: eventId: The event id
id: The catalog id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the details of a catalog from the given event and catalog id as JSON
404: Not Found, No event or catalog with this identifier was found.
Notes:
  • Return value description: The details of a catalog from the given event and catalog id as JSON
Testing:
Sample: /{eventId}/asset/catalog/{id}.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/catalog/catalogs.json
Description: Returns a list of catalogs from the given event as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns a list of catalogs from the given event as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The list of catalogs from the given event as JSON
Testing:
Sample: /{eventId}/asset/catalog/catalogs.json
Testing form (click to reveal)
Method / Path: GET /catalogAdapters
Description: Returns the available catalog UI adapters as JSON
Path params: NONE
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the available catalog UI adapters as JSON
Notes:
  • Return value description: The catalog UI adapters as JSON
Testing:
Sample: /catalogAdapters
/admin-ng/event/catalogAdapters
Method / Path: GET /{eventId}
Description: Returns the event by the given id as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the event as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The event as JSON
Testing:
Sample: /{eventId}
Testing form (click to reveal)
Method / Path: GET /{eventId}/access.json
Description: Get the access information of an event
Path params: eventId: The event identifier
Optional (query) params: NONE
Response formats: application/json
Status codes: 400: Bad Request, The required form params were missing in the request.
404: Not Found, If the event has not been found.
200: OK, The access information
Notes:
  • Return value description: The access information
Testing:
Sample: /{eventId}/access.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/comment/{commentId}
Description: Returns the comment with the given identifier
Path params: eventId: The event id
commentId: The comment identifier
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, The comment as JSON.
404: Not Found, No event or comment with this identifier was found.
Notes:
  • Return value description: Returns the comment as JSON
Testing:
Sample: /{eventId}/comment/{commentId}
Testing form (click to reveal)
Method / Path: GET /{eventId}/comments
Description: Returns all the data related to the comments tab in the event details modal as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event comments tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event comments tab as JSON
Testing:
Sample: /{eventId}/comments
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows/{workflowId}/errors/{errorId}.json
Description: Returns all the data related to the workflow/error tab in the event details modal as JSON
Path params: eventId: The event id
workflowId: The workflow id
errorId: The error id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event workflow/error tab as JSON
400: Bad Request, Unable to parse workflowId
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event workflow/error tab as JSON
Testing:
Sample: /{eventId}/workflows/{workflowId}/errors/{errorId}.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows/{workflowId}/errors.json
Description: Returns all the data related to the workflow/errors tab in the event details modal as JSON
Path params: eventId: The event id
workflowId: The workflow id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event workflow/errors tab as JSON
400: Bad Request, Unable to parse workflowId
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event workflow/errors tab as JSON
Testing:
Sample: /{eventId}/workflows/{workflowId}/errors.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/tobira/pages
Description: Returns the pages of a connected Tobira instance that contain the given event
Path params: eventId: The event identifier
Optional (query) params: NONE
Status codes: 200: OK, The Tobira pages containing the given event
404: Not Found, Tobira doesn't know about the given event
503: Service Unavailable, Tobira is not configured (correctly)
Notes:
  • Return value description: The Tobira pages that contain the given event
Testing:
Sample: /{eventId}/tobira/pages
Testing form (click to reveal)
Method / Path: GET /{eventId}/metadata.json
Description: Returns all the data related to the metadata tab in the event details modal as JSON
Path params: eventId: 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: /{eventId}/metadata.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows/{workflowId}/operations/{operationPosition}
Description: Returns all the data related to the workflow/operation tab in the event details modal as JSON
Path params: eventId: The event id
workflowId: The workflow id
operationPosition(Default value=0): The operation position
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event workflow/operation tab as JSON
400: Bad Request, Unable to parse workflowId or operationPosition
404: Not Found, No operation with these identifiers was found.
Notes:
  • Return value description: All the data related to the event workflow/opertation tab as JSON
Testing:
Sample: /{eventId}/workflows/{workflowId}/operations/{operationPosition}
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows/{workflowId}/operations.json
Description: Returns all the data related to the workflow/operations tab in the event details modal as JSON
Path params: eventId: The event id
workflowId: The workflow id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event workflow/operations tab as JSON
400: Bad Request, Unable to parse workflowId
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event workflow/opertations tab as JSON
Testing:
Sample: /{eventId}/workflows/{workflowId}/operations.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/publications.json
Description: Returns all the data related to the publications tab in the event details modal as JSON
Path params: eventId: The event id (mediapackage id).
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event publications tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event publications tab as JSON
Testing:
Sample: /{eventId}/publications.json
Testing form (click to reveal)
Method / Path: GET /events.json
Description: Returns all the events as JSON
Path params: NONE
Optional (query) params: filter: The filter used for the query. They should be formated like that: 'filter1:value1,filter2:value2'
sort: The order instructions used to sort the query result. Must be in the form ':(ASC|DESC)'
limit(Default value=0): The maximum number of items to return per page.
offset(Default value=0): The page number.
getComments: If comments should be fetched
Response formats: application/json
Status codes: 200: OK, Returns all events as JSON
Notes:
  • Return value description: All the events as JSON
Testing:
Sample: /events.json?filter={filter}&sort={sort}&limit=0&offset=0&getComments={getComments}
Testing form (click to reveal)
Method / Path: GET /{eventId}/scheduling.json
Description: Returns all of the scheduling metadata for an event
Path params: eventId: The event id (mediapackage id).
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event scheduling tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the technical metadata related to scheduling as JSON
Testing:
Sample: /{eventId}/scheduling.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows/{workflowId}
Description: Returns all the data related to the single workflow tab in the event details modal as JSON
Path params: eventId: The event id
workflowId: The workflow id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event single workflow tab as JSON
400: Bad Request, Unable to parse workflowId
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event singe workflow tab as JSON
Testing:
Sample: /{eventId}/workflows/{workflowId}
Testing form (click to reveal)
Method / Path: GET /{eventId}/workflows.json
Description: Returns all the data related to the workflows tab in the event details modal as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event workflows tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the data related to the event workflows tab as JSON
Testing:
Sample: /{eventId}/workflows.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/media/{id}.json
Description: Returns the details of a media from the given event and media id as JSON
Path params: eventId: The event id
id: The media id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the media of a catalog from the given event and media id as JSON
404: Not Found, No event or media with this identifier was found.
Notes:
  • Return value description: The details of a media from the given event and media id as JSON
Testing:
Sample: /{eventId}/asset/media/{id}.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/media/media.json
Description: Returns a list of media from the given event as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns a list of media from the given event as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The list of media from the given event as JSON
Testing:
Sample: /{eventId}/asset/media/media.json
Testing form (click to reveal)
Method / Path: GET /new/metadata
Description: Returns all the data related to the metadata tab in the new event modal as JSON
Path params: NONE
Optional (query) params: NONE
Status codes: 200: OK, Returns all the data related to the event metadata tab as JSON
Notes:
  • Return value description: All the data related to the event metadata tab as JSON
Testing:
Sample: /new/metadata
/admin-ng/event/new/metadata
Method / Path: GET /new/processing
Description: Returns all the data related to the processing tab in the new event modal as JSON
Path params: NONE
Optional (query) params: tags: A comma separated list of tags to filter the workflow definitions
Status codes: 200: OK, Returns all the data related to the event processing tab as JSON
Notes:
  • Return value description: All the data related to the event processing tab as JSON
Testing:
Sample: /new/processing?tags={tags}
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/publication/{id}.json
Description: Returns the details of a publication from the given event and publication id as JSON
Path params: eventId: The event id
id: The publication id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the publication of a catalog from the given event and publication id as JSON
404: Not Found, No event or publication with this identifier was found.
Notes:
  • Return value description: The details of a publication from the given event and publication id as JSON
Testing:
Sample: /{eventId}/asset/publication/{id}.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/asset/publication/publications.json
Description: Returns a list of publications from the given event as JSON
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns a list of publications from the given event as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The list of publications from the given event as JSON
Testing:
Sample: /{eventId}/asset/publication/publications.json
Testing form (click to reveal)
Method / Path: GET /{eventId}/hasActiveTransaction
Description: Returns whether there is currently a transaction in progress for the given event
Path params: eventId: The event id
Optional (query) params: NONE
Response formats: text/plain
Status codes: 200: OK, Returns whether there is currently a transaction in progress for the given event
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: Whether there is currently a transaction in progress for the given event
Testing:
Sample: /{eventId}/hasActiveTransaction
Testing form (click to reveal)

Write methods

Method / Path: POST /{eventId}/access
Description: Immediate application of an ACL to an event
Path params: eventId: The event ID
Required (form) params: acl: The ACL to apply
Optional (form) params: NONE
Status codes: 200: OK, The ACL has been successfully applied
400: Bad Request, Unable to parse the given ACL
404: Not Found, The the event has not been found
401: Unauthorized, Not authorized to perform this action
500: Internal Server Error, Internal error
Notes:
  • Return value description: Status code
Testing:
Sample: /{eventId}/access
Testing form (click to reveal)
Method / Path: PUT /bulk/update
Description: Update all of the given events at once
Path params: NONE
Required (form) params: update: The list of groups with events and fields to update.
Optional (form) params: NONE
Status codes: 200: OK, All events have been updated successfully.
400: Bad Request, Could not parse update instructions.
500: Internal Server Error, Field updating metadata or scheduling information. Some events may have been updated. Details are available in the response body.
404: Not Found, The events in the response body were not found. No events were updated.
Notes:
  • Return value description: In case of success, no content is returned. In case of errors while updating the metadata or scheduling information, the errors are returned. In case events were not found, their ids are returned
Testing:
Sample: /bulk/update
Testing form (click to reveal)
Method / Path: POST /new/conflicts
Description: Checks if the current scheduler parameters are in a conflict with another event
Path params: NONE
Required (form) params: metadata: The metadata as JSON
Optional (form) params: NONE
Status codes: 204: No Content, No conflicting events found
409: Conflict, There is a conflict
400: Bad Request, Missing or invalid parameters
Notes:
  • Return value description: Returns NO CONTENT if no event are in conflict within specified period or list of conflicting recordings in JSON
Testing:
Sample: /new/conflicts
Testing form (click to reveal)
Method / Path: POST /{eventId}/comment
Description: Creates a comment related to the event given by the identifier
Path params: eventId: The event id
Required (form) params: text: The comment text
Optional (form) params: resolved: The comment resolved status
reason: The comment reason
Response formats: application/json
Status codes: 201: Created, The comment has been created.
400: Bad Request, If no text ist set.
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The comment related to the event as JSON
Testing:
Sample: /{eventId}/comment
Testing form (click to reveal)
Method / Path: POST /{eventId}/comment/{commentId}/reply
Description: Creates an event comment reply
Path params: eventId: The event id
commentId: The comment identifier
Required (form) params: text: The comment reply text
Optional (form) params: resolved: Flag defining if this reply solve or not the comment.
Status codes: 404: Not Found, The event or comment to extend with a reply has not been found.
400: Bad Request, If no text is set.
200: OK, The updated comment as JSON.
Notes:
  • Return value description: The updated comment as JSON.
Testing:
Sample: /{eventId}/comment/{commentId}/reply
Testing form (click to reveal)
Method / Path: POST /new
Description: Creates a new event by the given metadata as JSON and the files in the body
Path params: NONE
Required (form) params: metadata: The metadata as JSON
Optional (form) params: NONE
Status codes: 201: Created, Event sucessfully added
400: Bad Request, If the metadata is not set or couldn't be parsed
Notes:
  • Return value description: The workflow identifier
Testing:
Sample: /new
Testing form (click to reveal)
Method / Path: DELETE /{eventId}
Description: Delete a single event.
Path params: eventId: The id of the event to delete.
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, The event has been deleted.
202: Accepted, The event will be retracted and deleted afterwards.
401: Unauthorized, If the current user is not authorized to perform this action
Notes:
  • Return value description: Ok if the event has been deleted.
Testing:
Sample: /{eventId}
Testing form (click to reveal)
Method / Path: DELETE /{eventId}/comment/{commentId}
Description: Deletes a event related comment by its identifier
Path params: eventId: The event id
commentId: The comment id
Optional (query) params: NONE
Response formats: application/json
Status codes: 204: No Content, The event related comment has been deleted.
404: Not Found, No event or comment with this identifier was found.
Notes:
  • Return value description: No content
Testing:
Sample: /{eventId}/comment/{commentId}
Testing form (click to reveal)
Method / Path: DELETE /{eventId}/comment/{commentId}/{replyId}
Description: Delete an event comment reply
Path params: eventId: The event id
commentId: The comment identifier
replyId: The comment reply identifier
Optional (query) params: NONE
Status codes: 404: Not Found, No event comment or reply with this identifier was found.
200: OK, The updated comment as JSON.
Notes:
  • Return value description: The updated comment as JSON.
Testing:
Sample: /{eventId}/comment/{commentId}/{replyId}
Testing form (click to reveal)
Method / Path: POST /deleteEvents
Description: Deletes a json list of events by their given ids e.g. ["1dbe7255-e17d-4279-811d-a5c7ced689bf", "04fae22b-0717-4f59-8b72-5f824f76d529"]
Path params: NONE
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, Events have been deleted
400: Bad Request, The list of ids could not be parsed into a json list.
401: Unauthorized, If the current user is not authorized to perform this action
Notes:
  • Return value description: Returns a JSON object containing a list of event ids that were deleted, not found or if there was a server error.
Testing:
Sample: /deleteEvents
Testing form (click to reveal)
Method / Path: DELETE /{eventId}/workflows/{workflowId}
Description: Deletes a workflow
Path params: eventId: The event identifier
workflowId(Default value=0): The workflow identifier
Optional (query) params: NONE
Status codes: 400: Bad Request, When trying to delete the latest workflow of the event.
404: Not Found, If the event or the workflow has not been found.
204: No Content, The method does not return any content
Notes:
  • Return value description: The method doesn't return any content
Testing:
Sample: /{eventId}/workflows/{workflowId}
Testing form (click to reveal)
Method / Path: POST /bulk/conflicts
Description: Checks if the current bulk update scheduling settings are in a conflict with another event
Path params: NONE
Required (form) params: update: The list of events and fields to update.
Optional (form) params: NONE
Status codes: 204: No Content, No conflicting events found
404: Not Found, The events in the response body were not found. No events were updated.
409: Conflict, There is a conflict
400: Bad Request, Missing or invalid parameters
Notes:
  • Return value description: Returns NO CONTENT if no event are in conflict within specified period or list of conflicting recordings in JSON
Testing:
Sample: /bulk/conflicts
Testing form (click to reveal)
Method / Path: POST /events/metadata.json
Description: Returns all the data related to the edit events metadata modal as JSON
Path params: NONE
Required (form) params: eventIds: The event ids
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the edit events metadata modal as JSON
404: Not Found, No events to update, either not found or with running workflow, details in response body.
Notes:
  • Return value description: All the data related to the edit events metadata modal as JSON
Testing:
Sample: /events/metadata.json
Testing form (click to reveal)
Method / Path: POST /scheduling.json
Description: Returns all of the scheduling metadata for a list of events
Path params: NONE
Required (form) params: eventIds: An array of event IDs (mediapackage id)
ignoreNonScheduled: Whether events that are not really scheduled events should be ignored or produce an error
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns all the data related to the event scheduling tab as JSON
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: All the technical metadata related to scheduling as JSON
Testing:
Sample: /scheduling.json
Testing form (click to reveal)
Method / Path: POST /{eventId}/comment/{commentId}
Description: Resolves an event comment
Path params: eventId: The event id
commentId: The comment identifier
Optional (form) params: NONE
Status codes: 404: Not Found, The event or comment to resolve has not been found.
200: OK, The resolved comment as JSON.
Notes:
  • Return value description: The resolved comment.
Testing:
Sample: /{eventId}/comment/{commentId}
Testing form (click to reveal)
Method / Path: POST /{eventId}/assets
Description: Update or create an asset for the eventId by the given metadata as JSON and files in the body
Path params: eventId: The event id
Required (form) params: metadata: The list of asset metadata
Optional (form) params: NONE
Status codes: 200: OK, The asset has been added.
400: Bad Request, Could not add asset, problem with the metadata or files.
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The workflow identifier
Testing:
Sample: /{eventId}/assets
Testing form (click to reveal)
Method / Path: PUT /{eventId}/comment/{commentId}
Description: Updates an event comment
Path params: eventId: The event id
commentId: The comment identifier
Optional (form) params: text: The comment text
reason: The comment reason
resolved: The comment resolved status
Status codes: 404: Not Found, The event or comment to update has not been found.
200: OK, The updated comment as JSON.
Notes:
  • Return value description: The updated comment as JSON.
Testing:
Sample: /{eventId}/comment/{commentId}
Testing form (click to reveal)
Method / Path: PUT /{eventId}/comment/{commentId}/{replyId}
Description: Updates an event comment reply
Path params: eventId: The event id
commentId: The comment identifier
replyId: The comment reply identifier
Required (form) params: text: The comment reply text
Optional (form) params: NONE
Status codes: 404: Not Found, The event or comment to extend with a reply or the reply has not been found.
400: Bad Request, If no text is set.
200: OK, The updated comment as JSON.
Notes:
  • Return value description: The updated comment as JSON.
Testing:
Sample: /{eventId}/comment/{commentId}/{replyId}
Testing form (click to reveal)
Method / Path: PUT /{eventId}/metadata
Description: Update the passed metadata for the event with the given Id
Path params: eventId: The event id
Required (form) params: metadata: The list of metadata to update
Optional (form) params: NONE
Status codes: 200: OK, The metadata have been updated.
400: Bad Request, Could not parse metadata.
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: No content is returned.
Testing:
Sample: /{eventId}/metadata
Testing form (click to reveal)
Method / Path: PUT /{eventId}/scheduling
Description: Updates the scheduling information of an event
Path params: eventId: The event identifier
Required (form) params: scheduling: The updated scheduling (JSON object)
Optional (form) params: NONE
Status codes: 400: Bad Request, The required params were missing in the request.
404: Not Found, If the event has not been found.
204: No Content, The method doesn't return any content
Notes:
  • Return value description: The method doesn't return any content
Testing:
Sample: /{eventId}/scheduling
Testing form (click to reveal)
Method / Path: PUT /events/metadata
Description: Update the passed metadata for the events with the given ids
Path params: NONE
Required (form) params: eventIds: The ids of the events to update
metadata: The metadata fields to update
Optional (form) params: NONE
Status codes: 204: No Content, All events have been updated successfully.
500: Internal Server Error, One or multiple errors occured while updating event metadata. Some events may have been updated successfully. Details are available in the response body.
Notes:
  • Return value description: In case of complete success, no content is returned. Otherwise, the response content contains the ids of events that couldn't be found and the ids and errors of events where the update failed as well as the ids of the events that were updated successfully.
Testing:
Sample: /events/metadata
Testing form (click to reveal)
Method / Path: PUT /{eventId}/workflows
Description: Update the workflow configuration for the scheduled event with the given id
Path params: eventId: The event id
Required (form) params: configuration: The workflow configuration as JSON
Optional (form) params: NONE
Status codes: 204: No Content, Request executed succesfully
404: Not Found, No event with this identifier was found.
Notes:
  • Return value description: The method does not retrun any content.
Testing:
Sample: /{eventId}/workflows
Testing form (click to reveal)
Method / Path: PUT /{eventId}/workflows/{workflowId}/action/{action}
Description: Performs the given action for the given workflow.
Path params: eventId: The id of the media package
workflowId: The id of the workflow
action: The action to take: STOP, RETRY or NONE (abort processing)
Optional (form) params: NONE
Status codes: 200: OK, Workflow resumed.
404: Not Found, Event or workflow instance not found.
400: Bad Request, Invalid action entered.
401: Unauthorized, You do not have permission to perform the action. Maybe you need to authenticate.
500: Internal Server Error, An exception occurred.
Testing:
Sample: /{eventId}/workflows/{workflowId}/action/{action}
Testing form (click to reveal)
Method / Path: POST /workflowProperties
Description: Returns workflow properties for the specified events
Path params: NONE
Required (form) params: eventIds: A JSON array of ids of the events
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, Returns the workflow properties for the events as JSON
400: Bad Request, The list of ids could not be parsed into a json list.
Notes:
  • Return value description: The workflow properties for every event as JSON
Testing:
Sample: /workflowProperties
Testing form (click to reveal)