Skip to content
Ontime documentation

Project data

Rundown

Section titled “Rundown”

The following endpoints allow operations on the rundown of the currently loaded project.

GET Rundown

Section titled “GET Rundown”

Allows requesting the full rundown or a optionally a paginated section.

Request

Terminal window
GET <localhost:4001>/data/rundown

Request Query Params

| param                | value                |
| -------------------- | -------------------- |
| offset               | Optional<number>     |
| limit                | Optional<number>     |

Response

200: {"rundown": OntimeEvent[], "total": number}

GET Event with ID

Section titled “GET Event with ID”

Returns an event data given its ID.

Request

Terminal window
GET <localhost:4001>/data/rundown/:eventId

Request Params

| param                | value                |
| -------------------- | -------------------- |
| offset               | Required<string>     |

Response

200: {OntimeEvent}

POST Event

Section titled “POST Event”

Adds a new event to the rundown.

Request

Terminal window
POST <localhost:4001>/data/rundown

Request Body

The endpoint expect the properties of Ontime Event. All properties are optional.

Additionally you can send an after property with the ID of the event after which the element should be added.
If this property is not provided, the event is appended to the end of the rundown.

| property             | value                       |
| -------------------- | --------------------------- |
| type                 | "event" | "delay" | "block" |
| after                | Optional<string>            |

Response

201: {OntimeEvent}

PUT Event

Section titled “PUT Event”

Patches the contents of an existing event.

Request

Terminal window
PUT <localhost:4001>/data/rundown/:eventId

Request Body

The endpoint expect a patch object that includes an event ID and any of the properties of Ontime Event.

All properties are optional.

| property             | value                       |
| -------------------- | --------------------------- |
| id                   | Required<string>            |

Response

The response contains the event as it is added to the rundown.

200: {OntimeEvent}

DELETE Event

Section titled “DELETE Event”

Deletes events given its IDs.

Request

Terminal window
DELETE <localhost:4001>/data/rundown/:eventId

Request Body

| param                | value                |
| -------------------- | -------------------- |
| ids                  | Required<string[]>   |

Response

204: {message: 'Events deleted'}