This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

API Reference

REST API for assets, channels and schedules

1 - Channel REST API v1

Reference for the channel schedule API

The following is a rendering of the OpenAPI for the channels and schedules of ESB3019 using swagger. This page does not have a backend server, so it cannot be run interactively.

However, an interactive Swagger API page is available directly at the ew-vod2cbm server at <server>/swagger/.

All API calls are relative to the base URL /api/v1/.

A new addition in release 1.2.0 is padding of assets. This is controlled via the boolean padLastGop parameters on channel and entry level, where the latter takes precedence over the former.

For more information about how to use this API, see the howto section.

2 - Old API references

Previous REST API Versions

2.1 - REST API v1 - release 1.0

Reference for the channel schedule API release 1.0

The following is a rendering of the OpenAPI for the channels and schedules of ESB3019 using swagger. This page does not have a backend server, so it cannot be run interactively.

However, an interactive Swagger API page is available directly at the ew-vod2cbm server at <server>/swagger/.

All API calls are relative to the base URL /api/v1/.

For more information about how to use this API, see the howto section.

2.2 - REST API v1 - release 1.2.0

Reference for the channel schedule API release 1.0

The following is a rendering of the OpenAPI for the channels and schedules of ESB3019 using swagger. This page does not have a backend server, so it cannot be run interactively.

However, an interactive Swagger API page is available directly at the ew-vod2cbm server at <server>/swagger/.

All API calls are relative to the base URL /api/v1/.

For more information about how to use this API, see the howto section.

2.3 - REST API v1 - release 0.10

Reference for the channel schedule API release 0.10.0

The following is a rendering of the OpenAPI for the channels and schedules of ESB3019 using swagger. This page does not have a backend server, so it cannot be run interactively.

However, an interactive Swagger API page is available directly at the ew-vod2cbm server at <server>/swagger/.

All API calls are relative to the base URL /api/v1/.

For more information about how to use this API, see the howto section.

2.4 - REST API v1 - release 0.8

Reference for the channel schedule API release 0.8.0

The following is a rendering of the OpenAPI for the channels and schedules of ESB3019 using swagger. This page does not have a backend server, so it cannot be run interactively.

However, an interactive Swagger API page is available directly at the ew-vod2cbm server at <server>/swagger/.

All API calls are relative to the base URL /api/v1/.

For more information about how to use this API, see the howto section.