The Mosart Remote Control Service (RCS) provides a REST API for controlling Viz Mosart rundowns using REST.

Getting started

To begin using the Mosart REST API

1. Copy RemoteDispatcherServiceConfig.xml inC:\Program Files (x86)\Mosart Medialab\Mosart Server\ConfigurationFiles
   to
   C:\ProgramData\Mosart Medialab\ConfigurationFiles.

2. Open the copied file in a text editor.

   1. Locate the <item> element with name="RestApiKey"

   2. Set the value to an arbitrary, unique string that you choose.
      All API clients must include this key to authorize their requests.
      For example:

      <?xml version="1.0" encoding="UTF-8"?>

      <RemoteServiceConfig>

      <Properties>

      ...

      <item name="RestApiKey" value="test-api-key" />

   3. Save the file.

3. From Windows Services, restart the Mosart Remote Control Service.

4. Make an HTTP request to http://[machine-name]:55167.
   For example:

   curl -X GET "http://localhost:55167/api/v1/command/reload" -H "accept: */*" -H "X-API-Key: test-api-key"

HTTPS

If you want to enable accessing the API via HTTPS, you need to edit the RemoteDispatcherServiceConfig.xml changing the following items:

Main/backup setup

If you want your API calls to go to the currently active Mosart Server, you can route them through Mosart Web Applications.

Install it on a separate machine and configure it to connect to both main and backup. Then you can use the endpoint http://[web-apps-machine-name]:65152 and Web Apps will act as a proxy and redirect the call to the active server.

Swagger Documentation

Mosart Server ships with an interactive documentation page that will be available after enabling the Mosart REST API.

Explore interactively: Swagger UI (local instance).

Endpoints

Assets

List Graphics

GET /api/v1/assets/graphics (since v5.13.0)

Get a list of all the overlay graphics in the rundown.

Take/Take out Graphics

POST /api/v1/assets/graphics/{mosartItemId}/take (since v5.13.0)
POST /api/v1/assets/graphics/{mosartItemId}/take-out (since v5.13.0)

Take or take out an overlay graphics by its Mosart id.

mosartItemId: The id of the overlay graphic you want to take out. id property from /graphics.

POST /api/v1/assets/graphics/take?name={name} (since v5.13.0)
POST /api/v1/assets/graphics/take-out?name={name} (since v5.13.0)

Take or take out an overlay graphics by its name.

name: The slug of the graphic. This is the name visible in the Viz Mosart GUI. slug property from /graphics.

Devices

Standby Device

PATCH /api/v1/devices/{type} (since v5.13.0)

Sets the standby status of the specified device type.

type: audio, audio-player, fullscreen-graphics, generic-rest, gpi, graphics, lights, loudness, robotic-camera, router, subtitling, switcher, video, video-wall, virtual-set, weather.-graphics, generic-rest, graphics, robotic-camera

PATCH /api/v1/devices/{type}/{id} (since v5.13.0)

Sets the standby state for a single device/controller identified by one ID.

type: fullscreen-graphics, generic-rest, graphics, robotic-camera

id: The device (or controller) ID. For graphics, this can be the engine ID or the destination.

PATCH /api/v1/devices/{type}/{controllerId}/{deviceId} (since v5.13.0)

Sets standby for a device addressed by controller and device ids.

type: robotic-camera

controllerId: The controller ID.

deviceId: The device ID.

Media

Search media

GET /api/v1/media/search?name={clip-name} (since v5.11.0)

Searches the video servers configured in Mosart and returns a list of clips.

clip-name: The word you want to search for.

Settings

Get NRCS settings

GET /api/v1/settings/nrcs (since v5.13.0)

Get the details of how Mosart is configured to connect to the NRCS.

Update NRCS settings

PATCH /api/v1/settings/nrcs (since v5.13.0)

Change the NRCS connection in Mosart. Can we used to switch between different NRCS systems. I.e. using Showmaker for certain shows.

Status

Build

GET /build (since v5.1.0)
GET /api/v1/build (since v5.4.0)

Information about the version of the Mosart Server.

Status

GET /status (since v5.4.0)
GET /api/v1/status (since v5.4.0)

Get the status of the Mosart server.

Timeline

Timeline Information

GET /api/v1/timeline (since v5.13.0)

Get timeline information including timeline status, current story, next story, current item and next item.

Rundown

GET /api/v1/rundown (since v5.13.0)

Get the rundown that is currently loaded.

Open Rundown

GET /api/v1/command/open-rundown?id={rundown-id} (since v5.10.0)

Load a specific rundown in Mosart.

rundowm-id: Either the name or id of the rundown. Both can be found from the response of /rundown.

Reload Rundown

GET /api/v1/command/reload (since v5.4.0)

Reload the current rundown.

Take Next

GET /api/v1/command/start-continue (since v5.4.0)

Take the next item in the rundown. Has some optional URL parameters:

option: Default, Continue, Mix, Wipe, Effect

rate: The transition rate for mix/wipe (integer)

effect: The effect number (integer)

delay: The delay in milliseconds for continue (integer)

Skip Next

GET /api/v1/command/skip-next (since v5.10.0)

Skip the next item in the rundown.

Unskip Next

GET /api/v1/command/un-skip-next (since v5.10.0)

Unskip the last skipped item in the rundown.

Skip Next Sub Item

GET /api/v1/command/skip-next-sub-item (since v5.10.0)

Skip the next sub item in the rundown.

Unskip Next Sub Item

GET /api/v1/command/un-skip-next-sub-item (since v5.10.0)

Unskip the last skipped sub item in the rundown.

Start Rundown from Top

GET /api/v1/command/start-from-top (since v5.4.0)

Restart the rundown from the first story.

Set as Next

GET /api/v1/command/set-as-next?storyid={story-id} (since v5.10.0)

Set story as next.

Enable/Disable Rehearsal Mode

GET /api/v1/command/rehearsal-mode?state={state} (since v5.4.0)

Enable/disable/toggle rehearsal mode.

state: true = enable, false = disable, no parameter = toggle.

Take a Template

GET /api/v1/command/template?type={template-type}&variant={variant}&bus={preview|program}&insert={true|false} (since v5.4.0)

Takes the template by its type and variant (name) as well as optionally, which bus (Preview or Program) and, for Preview bus, the insert option (if the template should be inserted in front of or overwrite an existing manual item). If an optional parameter is not used, the defaults are program (for bus) and false for insert.

Examples:

GET /api/v1/command/template?type=Camera&variant=CAM1
This will cut the Camera template variant CAM1 directly to Program.

GET /api/v1/command/template?type=Camera&variant=CAM1&bus=PREVIEW

This will put the Camera template variant CAM1 into Preview, replacing any manual item already in Preview.

GET /api/v1/command/template?type=Camera&variant=CAM1&bus=PREVIEW&insert=true

This will put the Camera template variant CAM1 into Preview, inserted in front of the item currently in Preview, not overwriting any manual item in Preview.

Trigger a DirectTake Template

GET /api/v1/command/directtake?number={number} (since v5.4.0)

Trigger a given DirectTake template. You must provide the number of the desired template.

Trigger Control Command

GET /api/v1/command/controlcommand/{command}?params… (since v5.10.0)

Trigger a control command in Mosart.

See also

• section Keyboard-based Control Command Categories in the Viz Mosart User Guide (Viz Mosart User Interface > Keyboard Shortcuts > Control Command Keys) and

• section Command Values and Parameters in the Viz Mosart Administration Guide (Show Design and Template Editor > Working with Templates > Control Commands in Templates).