Rundown Studio

Rundown Studio is an HTTP-backed action that triggers a selected Rundown Studio API command or a custom raw HTTP request, optionally including path/query parameters, with authentication via query token and/or Authorization: Bearer header.

Required Parameters(bulleted list)

• host: required, must be non-empty after trimming.
• port: integer field with range constraints 0...65535 (used when host has no scheme).
• useHTTPS: determines generated scheme when host has no scheme.
• token: optional query authentication parameter appended as token=... when present.
• bearerToken: optional; if provided it is sent as Authorization header (auto-prefixed with Bearer unless already present).
• useRawRequest: required mode switch.
• rawMethod and rawPath: required only when useRawRequest = true; rawPath must be non-empty.
• command: required only when useRawRequest = false; must match a catalog command id.

Commands

Start Rundown

• Required Inputs:
  • rundownId (path).
• Constraints / Ranges:
  • host required and non-empty.
  • rundownId required/checked before send.
• Supported targets/options:
  • GET /rundown/{rundownId}/start
  • No body support.
  • No query parameters beyond optional token.

Pause Rundown

• Required Inputs:
  • rundownId (path).
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • GET /rundown/{rundownId}/pause
  • No body support.
  • No query parameters beyond optional token.

Next Cue

• Required Inputs:
  • rundownId (path).
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • GET /rundown/{rundownId}/next
  • No body support.
  • No query parameters beyond optional token.

Previous Cue

• Required Inputs:
  • rundownId (path).
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • GET /rundown/{rundownId}/previous
  • No body support.
  • No query parameters beyond optional token.

Adjust Active Cue Duration

• Required Inputs:
  • rundownId (path).
  • subtractOrAdd (path, label suggests add or subtract).
• Constraints / Ranges:
  • rundownId and subtractOrAdd required/checked before send.
  • amount is optional; if empty it is omitted.
• Supported targets/options:
  • GET /rundown/{rundownId}/cues/active/{subtractOrAdd}
  • Supports optional query: amount.
  • No body support.

Jump To Cue

• Required Inputs:
  • rundownId (path).
  • cueId (path).
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • PUT /rundown/{rundownId}/cues/{cueId}/jump-to-cue
  • No body support.

Update Cue

• Required Inputs:
  • rundownId (path).
  • cueId (path).
  • JSON body (optional in UI; body is sent only when non-empty).
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • PATCH /rundown/{rundownId}/cues/{cueId}
  • Supports JSON body.
  • No query parameters defined by this command.

Replace Text Variables

• Required Inputs:
  • rundownId (path).
  • JSON body.
• Constraints / Ranges:
  • rundownId required/checked before send.
  • Body is optional at runtime but should be JSON for compatibility.
• Supported targets/options:
  • PUT /rundown/{rundownId}/text-variables
  • Supports JSON body.

Merge Text Variables

• Required Inputs:
  • rundownId (path).
  • JSON body.
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • PATCH /rundown/{rundownId}/text-variables
  • Supports JSON body.

Create Text Variable

• Required Inputs:
  • rundownId (path).
  • JSON body.
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • POST /rundown/{rundownId}/text-variables
  • Supports JSON body.

Update Text Variable

• Required Inputs:
  • rundownId (path).
  • key (path).
  • JSON body.
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • PUT /rundown/{rundownId}/text-variables/{key}
  • Supports JSON body.

Delete Text Variable

• Required Inputs:
  • rundownId (path).
  • key (path).
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • DELETE /rundown/{rundownId}/text-variables/{key}
  • No body support.

Create Mention

• Required Inputs:
  • rundownId (path).
  • JSON body.
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • POST /rundown/{rundownId}/mentions
  • Supports JSON body.

Bulk Update Mentions

• Required Inputs:
  • rundownId (path).
  • JSON body.
• Constraints / Ranges:
  • rundownId required/checked before send.
• Supported targets/options:
  • PUT /rundown/{rundownId}/mentions
  • Supports JSON body.

Update Mention

• Required Inputs:
  • rundownId (path).
  • key (path).
  • JSON body.
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • PUT /rundown/{rundownId}/mentions/{key}
  • Supports JSON body.

Delete Mention

• Required Inputs:
  • rundownId (path).
  • key (path).
• Constraints / Ranges:
  • both path values required/checked before send.
• Supported targets/options:
  • DELETE /rundown/{rundownId}/mentions/{key}
  • No body support.

Raw HTTP Request

• Required Inputs:
  • rawPath and rawMethod (when useRawRequest = true).
• Constraints / Ranges:
  • rawPath must be non-empty or request is not sent.
  • rawMethod is selected from GET, POST, PUT, PATCH, DELETE in schema options.
  • If rawPath is absolute (http:// or https://), it bypasses host/port path normalization and /api-v0 path injection.
• Supported targets/options:
  • Method options: GET, POST, PUT, PATCH, DELETE.
  • Optional JSON body; if non-empty, sent with Content-Type: application/json.