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.

Request

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

Response

200: {
  id: RundownId;
  title: string;
  order: EntryId[];
  flatOrder: EntryId[];
  entries: RundownEntries;
  revision: number;
}

POST Entry

Section titled “POST Entry”

Adds a new entry to the rundown.

Request

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

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" | "group" | "milestone" |
| after                | Optional<string>                          |

Response

201: {OntimeEntry}

PUT Event

Section titled “PUT Event”

Patches the contents of an existing event.

Request

Terminal window
PUT <localhost:4001>/data/rundown/:rundownId/:entryId

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: {OntimeEntry}

DELETE Event

Section titled “DELETE Event”

Deletes events given its IDs.

Request

Terminal window
DELETE <localhost:4001>/data/rundown/:rundownId/:entryId

Request Body

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

Response

204: {message: 'Events deleted'}