run_of_show_templates[].ref | string | | Stable | Name for this template inside the document. A workspace export writes the record’s ID here, so importing that export back into the same workspace matches each template to its own record before it looks at names. |
run_of_show_templates[].external_id | string | | Stable | The template’s ID in the source system, kept for reference. |
run_of_show_templates[].name | string | Yes | Stable | Run of show template name. |
run_of_show_templates[].description | string | | Stable | Run of show template description. |
run_of_show_templates[].default | boolean | | Stable | New gigs start from it. Import never moves the default away from another template. |
run_of_show_templates[].time_anchor_minutes | integer 0–1439 | | Stable | The clock time, in minutes after midnight, that offsets count from. Required when any section or cue gives an offset. |
run_of_show_templates[].provenance.catalog_key | string | | Stable | The Soundcheck starter catalog entry this run of show template came from. Import matches an org run of show template with the same key before it looks at names, and stores the key on a new one. |
run_of_show_templates[].provenance.catalog_version | integer ≥ 1 | | Stable | The release of that catalog entry. Stored on a new run of show template with the key. |
run_of_show_templates[].sections[].title | string | | Stable | Template section. |
run_of_show_templates[].sections[].day_offset | integer 0–365 | | Stable | Whole days after the gig start date (0 is the first day). |
run_of_show_templates[].sections[].start_clock_minutes | integer 0–1439 | | Stable | Start as minutes after midnight on its gig day, for a clock-timed entry. |
run_of_show_templates[].sections[].end_clock_minutes | integer 0–1439 | | Stable | End as minutes after midnight, after the start clock. For a window past midnight, give end_offset_minutes instead. |
run_of_show_templates[].sections[].start_offset_minutes | integer ≥ -2147483648 | | Stable | Start as minutes after the template anchor (time_anchor_minutes); negative is before it. Used when there is no start clock. |
run_of_show_templates[].sections[].end_offset_minutes | integer ≥ -2147483648 | | Stable | End as minutes after the template anchor. |
run_of_show_templates[].sections[].notes | string | | Stable | Template section notes. |
run_of_show_templates[].sections[].segment_kind | string | | Stable | What the section is: any of CEREMONY | COCKTAILS | RECEPTION | DINNER | DANCING | AFTER_PARTY | OTHER | SOUND_CHECK | LOAD_IN | REHEARSAL | DOORS | SHOW | INTERMISSION | LOAD_OUT. |
run_of_show_templates[].sections[].key_time_kind | string | | Stable | The gig key time this section sets, such as doors. |
run_of_show_templates[].sections[].track | string | | Stable | Template section track. |
run_of_show_templates[].sections[].color | string | | Stable | Template section color. |
run_of_show_templates[].sections[].booking_state | string | | Stable | Any of BOOKED | CONTEXT_ONLY. Defaults to BOOKED. |
run_of_show_templates[].sections[].location | string | | Stable | Template section location. |
run_of_show_templates[].sections[].ensemble | string | | Stable | Template section ensemble. |
run_of_show_templates[].sections[].piece_count | integer 0–99 | | Stable | Template section pieces. |
run_of_show_templates[].sections[].vocal_count | integer 0–99 | | Stable | Template section vocals. |
run_of_show_templates[].sections[].gear_notes | string | | Stable | Up to 2000 characters. |
run_of_show_templates[].sections[].sort_order | integer ≥ 0 | | Stable | Position of the section in the template. Defaults to its place in the list. |
run_of_show_templates[].sections[].cues[].title | string | | Stable | Template cue. |
run_of_show_templates[].sections[].cues[].item_type | string | | Stable | One of {options}. Defaults to general. One of general, song, break, announcement. |
run_of_show_templates[].sections[].cues[].timing_mode | string | | Stable | How the cue is timed: CLOCK | SEGUE | ON_CUE. ON_CUE needs a timing_label. |
run_of_show_templates[].sections[].cues[].timing_label | string | | Stable | Text shown in place of a clock time for an ON_CUE cue. Up to 120 characters. |
run_of_show_templates[].sections[].cues[].start_clock_minutes | integer 0–1439 | | Stable | Start as minutes after midnight on its gig day, for a clock-timed entry. |
run_of_show_templates[].sections[].cues[].end_clock_minutes | integer 0–1439 | | Stable | End as minutes after midnight, after the start clock. For a window past midnight, give end_offset_minutes instead. |
run_of_show_templates[].sections[].cues[].start_offset_minutes | integer ≥ -2147483648 | | Stable | Start as minutes after the template anchor (time_anchor_minutes); negative is before it. Used when there is no start clock. |
run_of_show_templates[].sections[].cues[].end_offset_minutes | integer ≥ -2147483648 | | Stable | End as minutes after the template anchor. |
run_of_show_templates[].sections[].cues[].duration_minutes | integer ≥ 0 | | Stable | Minimum length of the cue in minutes. |
run_of_show_templates[].sections[].cues[].duration_max_minutes | integer 0–1440 | | Stable | Longest the cue may run in minutes. Must be at least duration_minutes. |
run_of_show_templates[].sections[].cues[].notes | string | | Stable | Template cue notes. |
run_of_show_templates[].sections[].cues[].instructions | string | | Stable | Up to 4000 characters. |
run_of_show_templates[].sections[].cues[].announcement | string | | Stable | Template cue announcement. |
run_of_show_templates[].sections[].cues[].location | string | | Stable | Template cue location. |
run_of_show_templates[].sections[].cues[].ensemble | string | | Stable | Template cue ensemble. |
run_of_show_templates[].sections[].cues[].tentative | boolean | | Stable | Template cue tentative. |
run_of_show_templates[].sections[].cues[].key_time_kind | string | | Stable | The gig key time this cue sets, such as doors. |
run_of_show_templates[].sections[].cues[].linked_to_previous | string | | Stable | Links the cue to the cue right before it in its section: SEGUE | GROUP. SEGUE starts it when that cue ends; GROUP moves the two together. Ignored on the first cue of a section. |
run_of_show_templates[].sections[].cues[].playback_source | string | | Stable | Where the cue audio plays from: LIVE | TRACK | DS_IPAD | OTHER. |
run_of_show_templates[].sections[].cues[].note_roles | list of strings | | Stable | Who the cue note is for: any of SOUND | BAND_LEADER | PLANNER | MUSICIANS. |
run_of_show_templates[].sections[].cues[].audience_positions | list of strings | | Stable | Names of the org positions that see this cue. A name the org does not have is left out. |
run_of_show_templates[].sections[].cues[].sort_order | integer ≥ 0 | | Stable | Position of the cue in the template. Defaults to its place in the list. |
run_of_show_templates[].sections[].cues[].speakers[].name | string | Yes | Stable | Template cue speaker. |
run_of_show_templates[].sections[].cues[].speakers[].relationship | string | | Stable | Template cue speaker relationship. |
run_of_show_templates[].sections[].cues[].speakers[].minutes | integer 0–600 | | Stable | Template cue speaker minutes. |
run_of_show_templates[].sections[].cues[].songs[].title | string | Yes | Stable | Title of a song in the org repertoire. A song the org does not have is left out. |
run_of_show_templates[].sections[].cues[].songs[].artist | string | | Stable | Template cue song artist. |
run_of_show_templates[].cues[].title | string | | Stable | Template cue. |
run_of_show_templates[].cues[].item_type | string | | Stable | One of {options}. Defaults to general. One of general, song, break, announcement. |
run_of_show_templates[].cues[].timing_mode | string | | Stable | How the cue is timed: CLOCK | SEGUE | ON_CUE. ON_CUE needs a timing_label. |
run_of_show_templates[].cues[].timing_label | string | | Stable | Text shown in place of a clock time for an ON_CUE cue. Up to 120 characters. |
run_of_show_templates[].cues[].start_clock_minutes | integer 0–1439 | | Stable | Start as minutes after midnight on its gig day, for a clock-timed entry. |
run_of_show_templates[].cues[].end_clock_minutes | integer 0–1439 | | Stable | End as minutes after midnight, after the start clock. For a window past midnight, give end_offset_minutes instead. |
run_of_show_templates[].cues[].start_offset_minutes | integer ≥ -2147483648 | | Stable | Start as minutes after the template anchor (time_anchor_minutes); negative is before it. Used when there is no start clock. |
run_of_show_templates[].cues[].end_offset_minutes | integer ≥ -2147483648 | | Stable | End as minutes after the template anchor. |
run_of_show_templates[].cues[].duration_minutes | integer ≥ 0 | | Stable | Minimum length of the cue in minutes. |
run_of_show_templates[].cues[].duration_max_minutes | integer 0–1440 | | Stable | Longest the cue may run in minutes. Must be at least duration_minutes. |
run_of_show_templates[].cues[].notes | string | | Stable | Template cue notes. |
run_of_show_templates[].cues[].instructions | string | | Stable | Up to 4000 characters. |
run_of_show_templates[].cues[].announcement | string | | Stable | Template cue announcement. |
run_of_show_templates[].cues[].location | string | | Stable | Template cue location. |
run_of_show_templates[].cues[].ensemble | string | | Stable | Template cue ensemble. |
run_of_show_templates[].cues[].tentative | boolean | | Stable | Template cue tentative. |
run_of_show_templates[].cues[].key_time_kind | string | | Stable | The gig key time this cue sets, such as doors. |
run_of_show_templates[].cues[].playback_source | string | | Stable | Where the cue audio plays from: LIVE | TRACK | DS_IPAD | OTHER. |
run_of_show_templates[].cues[].note_roles | list of strings | | Stable | Who the cue note is for: any of SOUND | BAND_LEADER | PLANNER | MUSICIANS. |
run_of_show_templates[].cues[].audience_positions | list of strings | | Stable | Names of the org positions that see this cue. A name the org does not have is left out. |
run_of_show_templates[].cues[].sort_order | integer ≥ 0 | | Stable | Position of the cue in the template. Defaults to its place in the list. |
run_of_show_templates[].cues[].speakers[].name | string | Yes | Stable | Template cue speaker. |
run_of_show_templates[].cues[].speakers[].relationship | string | | Stable | Template cue speaker relationship. |
run_of_show_templates[].cues[].speakers[].minutes | integer 0–600 | | Stable | Template cue speaker minutes. |
run_of_show_templates[].cues[].songs[].title | string | Yes | Stable | Title of a song in the org repertoire. A song the org does not have is left out. |
run_of_show_templates[].cues[].songs[].artist | string | | Stable | Template cue song artist. |