RoadOpsDeveloper

Set Lists

Ask

List set lists

GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-lists

Lists set list records for an event.

Required scopes: set_list:read

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

query.limitinteger

Maximum number of records to return. Defaults to 50 and is capped at 200.

query.cursorstring

Cursor returned by page.nextCursor from the previous list response.

Response 200

dataobject[]
data[].dayIdstring:uuid

Day identifier that owns the event for this set list.

data[].eventIdstring:uuid

Event identifier that owns this set list.

data[].titlestring

Set list title.

data[].visibilityobject

Optional visibility rules for the set list.

data[].visibility.groupIdsstring:uuid[]
data[].visibility.userIdsstring:uuid[]
data[].itemslibraryItem | break[]

Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape.

data[].items[].idstring:uuid

Set list entry identifier.

data[].items[].type"libraryItem" | "break"

libraryItem: Use "libraryItem" for an entry backed by a reusable set list item. break: Use "break" for an intermission, pause, or other timed break in the set list.

data[].items[].setListItemIdstring:uuid

Reusable set list item identifier. Required when type is "libraryItem".

data[].items[].titlestring

libraryItem: Optional per-set override title. When omitted, RoadOps uses the library item title. break: Break label shown in the set list. Required when type is "break".

data[].items[].durationSecondsinteger

libraryItem: Optional per-set duration override in seconds. When omitted, RoadOps uses the library item duration. break: Break duration in seconds. Required when type is "break".

data[].items[].printTitlestring

Optional per-set print title override.

data[].items[].notesstring

Optional notes for this set list entry.

data[].idstring:uuid

Set list identifier.

data[].orgIdstring:uuid

Team identifier that owns this set list.

data[].isDeletedboolean

Whether the set list has been deleted.

data[].versioninteger

Current set list aggregate version.

data[].createdAtstring:date-time

ISO 8601 timestamp when the set list was created.

data[].createdBystring

User identifier that created this set list.

data[].updatedAtstring:date-time

ISO 8601 timestamp when the set list was last updated.

data[].updatedBystring

User identifier that last updated this set list.

data[].cursorinteger

Latest event-ledger cursor projected into this set list record.

pageobject
page.limitinteger

Maximum number of records returned in this page.

page.nextCursorstring | null

Cursor to pass as the next request's cursor query parameter, or null when there are no more results.

metaobject
meta.cursornumber | null

Highest record cursor represented by this response.

Create a set list

POST/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-lists

Accepts a command to create a set list for an event.

Required scopes: set_list:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

titlerequiredstring

Set list title.

visibilityobject

Optional visibility rules for this set list.

visibility.groupIdsstring:uuid[]
visibility.userIdsstring:uuid[]
itemsrequiredlibraryItem | break[]

Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape.

items[].idrequiredstring:uuid

Set list entry identifier.

items[].typerequired"libraryItem" | "break"

libraryItem: Use "libraryItem" for an entry backed by a reusable set list item. break: Use "break" for an intermission, pause, or other timed break in the set list.

items[].setListItemIdstring:uuid

Reusable set list item identifier. Required when type is "libraryItem".

items[].titlestring

libraryItem: Optional per-set override title. When omitted, RoadOps uses the library item title. break: Break label shown in the set list. Required when type is "break".

items[].durationSecondsinteger

libraryItem: Optional per-set duration override in seconds. When omitted, RoadOps uses the library item duration. break: Break duration in seconds. Required when type is "break".

items[].printTitlestring

Optional per-set print title override.

items[].notesstring

Optional notes for this set list entry.

idstring:uuid

Optional caller-supplied set list ID. RoadOps generates one when omitted.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.

Retrieve a set list

GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-lists/{setListId}

Returns one set list record by ID.

Required scopes: set_list:read

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.setListIdrequiredstring:uuid

Set list identifier.

Response 200

dataobject
data.dayIdstring:uuid

Day identifier that owns the event for this set list.

data.eventIdstring:uuid

Event identifier that owns this set list.

data.titlestring

Set list title.

data.visibilityobject

Optional visibility rules for the set list.

data.visibility.groupIdsstring:uuid[]
data.visibility.userIdsstring:uuid[]
data.itemslibraryItem | break[]

Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape.

data.items[].idstring:uuid

Set list entry identifier.

data.items[].type"libraryItem" | "break"

libraryItem: Use "libraryItem" for an entry backed by a reusable set list item. break: Use "break" for an intermission, pause, or other timed break in the set list.

data.items[].setListItemIdstring:uuid

Reusable set list item identifier. Required when type is "libraryItem".

data.items[].titlestring

libraryItem: Optional per-set override title. When omitted, RoadOps uses the library item title. break: Break label shown in the set list. Required when type is "break".

data.items[].durationSecondsinteger

libraryItem: Optional per-set duration override in seconds. When omitted, RoadOps uses the library item duration. break: Break duration in seconds. Required when type is "break".

data.items[].printTitlestring

Optional per-set print title override.

data.items[].notesstring

Optional notes for this set list entry.

data.idstring:uuid

Set list identifier.

data.orgIdstring:uuid

Team identifier that owns this set list.

data.isDeletedboolean

Whether the set list has been deleted.

data.versioninteger

Current set list aggregate version.

data.createdAtstring:date-time

ISO 8601 timestamp when the set list was created.

data.createdBystring

User identifier that created this set list.

data.updatedAtstring:date-time

ISO 8601 timestamp when the set list was last updated.

data.updatedBystring

User identifier that last updated this set list.

data.cursorinteger

Latest event-ledger cursor projected into this set list record.

metaobject
meta.cursorinteger

Highest record cursor represented by this response.

Update a set list

PATCH/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-lists/{setListId}

Accepts a command to update set list fields.

Required scopes: set_list:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.setListIdrequiredstring:uuid

Set list identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

expectedVersioninteger

Optional aggregate version guard.

updatesrequiredobject

Set list fields to update.

updates.titlestring

Set list title.

updates.itemslibraryItem | break[]

Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape.

updates.items[].idrequiredstring:uuid

Set list entry identifier.

updates.items[].typerequired"libraryItem" | "break"

libraryItem: Use "libraryItem" for an entry backed by a reusable set list item. break: Use "break" for an intermission, pause, or other timed break in the set list.

updates.items[].setListItemIdstring:uuid

Reusable set list item identifier. Required when type is "libraryItem".

updates.items[].titlestring

libraryItem: Optional per-set override title. When omitted, RoadOps uses the library item title. break: Break label shown in the set list. Required when type is "break".

updates.items[].durationSecondsinteger

libraryItem: Optional per-set duration override in seconds. When omitted, RoadOps uses the library item duration. break: Break duration in seconds. Required when type is "break".

updates.items[].printTitlestring

Optional per-set print title override.

updates.items[].notesstring

Optional notes for this set list entry.

updates.visibilityobject | null

Updated visibility rules, or null to clear them.

updates.visibility.groupIdsstring:uuid[]
updates.visibility.userIdsstring:uuid[]

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.

Delete a set list

DELETE/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-lists/{setListId}

Accepts a command to delete a set list.

Required scopes: set_list:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.setListIdrequiredstring:uuid

Set list identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.