Skip to content
XOS Developers

cues

Show module · 6 operations

List cue rows

GET/cues

A cue in a run of show. Returns a cursor page of cue rows the caller may see. The default order is `position` ascending. Supports sparse fieldsets and the filter grammar.

Create a cue

POST/cues

A cue in a run of show. Creates a cue. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a cue

GET/cues/{id}

A cue in a run of show. Returns one cue with its `ETag`. A cue the caller may not see returns 404.

Update a cue

PATCH/cues/{id}

A cue in a run of show. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a cue

DELETE/cues/{id}

A cue in a run of show. Soft-deletes the cue: it moves to Trash and can be restored for its table's retention period.

Call a cue

POST/cues/{id}/fire

Marks the cue as called now and advances the live run of show to the next cue. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.