Set Lists
Ask
List set lists
GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-listsLists set list records for an event.
Required scopes: set_list:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
query.limit | integerMaximum number of records to return. Defaults to 50 and is capped at 200. |
query.cursor | stringCursor returned by page.nextCursor from the previous list response. |
Response 200
data | object[] |
|---|---|
data[].dayId | string:uuidDay identifier that owns the event for this set list. |
data[].eventId | string:uuidEvent identifier that owns this set list. |
data[].title | stringSet list title. |
data[].visibility | objectOptional visibility rules for the set list. |
data[].visibility.groupIds | string:uuid[] |
data[].visibility.userIds | string:uuid[] |
data[].items | libraryItem | break[]Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape. |
data[].items[].id | string:uuidSet 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[].setListItemId | string:uuidReusable set list item identifier. Required when type is "libraryItem". |
data[].items[].title | stringlibraryItem: 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[].durationSeconds | integerlibraryItem: 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[].printTitle | stringOptional per-set print title override. |
data[].items[].notes | stringOptional notes for this set list entry. |
data[].id | string:uuidSet list identifier. |
data[].orgId | string:uuidTeam identifier that owns this set list. |
data[].isDeleted | booleanWhether the set list has been deleted. |
data[].version | integerCurrent set list aggregate version. |
data[].createdAt | string:date-timeISO 8601 timestamp when the set list was created. |
data[].createdBy | stringUser identifier that created this set list. |
data[].updatedAt | string:date-timeISO 8601 timestamp when the set list was last updated. |
data[].updatedBy | stringUser identifier that last updated this set list. |
data[].cursor | integerLatest event-ledger cursor projected into this set list record. |
page | object |
page.limit | integerMaximum number of records returned in this page. |
page.nextCursor | string | nullCursor to pass as the next request's cursor query parameter, or null when there are no more results. |
meta | object |
meta.cursor | number | nullHighest record cursor represented by this response. |
Create a set list
POST/v1/teams/{teamId}/days/{dayId}/events/{eventId}/set-listsAccepts a command to create a set list for an event.
Required scopes: set_list:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
titlerequired | stringSet list title. |
|---|---|
visibility | objectOptional visibility rules for this set list. |
visibility.groupIds | string:uuid[] |
visibility.userIds | string:uuid[] |
itemsrequired | libraryItem | break[]Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape. |
items[].idrequired | string:uuidSet 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[].setListItemId | string:uuidReusable set list item identifier. Required when type is "libraryItem". |
items[].title | stringlibraryItem: 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[].durationSeconds | integerlibraryItem: 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[].printTitle | stringOptional per-set print title override. |
items[].notes | stringOptional notes for this set list entry. |
id | string:uuidOptional caller-supplied set list ID. RoadOps generates one when omitted. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative 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.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.setListIdrequired | string:uuidSet list identifier. |
Response 200
data | object |
|---|---|
data.dayId | string:uuidDay identifier that owns the event for this set list. |
data.eventId | string:uuidEvent identifier that owns this set list. |
data.title | stringSet list title. |
data.visibility | objectOptional visibility rules for the set list. |
data.visibility.groupIds | string:uuid[] |
data.visibility.userIds | string:uuid[] |
data.items | libraryItem | break[]Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape. |
data.items[].id | string:uuidSet 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[].setListItemId | string:uuidReusable set list item identifier. Required when type is "libraryItem". |
data.items[].title | stringlibraryItem: 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[].durationSeconds | integerlibraryItem: 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[].printTitle | stringOptional per-set print title override. |
data.items[].notes | stringOptional notes for this set list entry. |
data.id | string:uuidSet list identifier. |
data.orgId | string:uuidTeam identifier that owns this set list. |
data.isDeleted | booleanWhether the set list has been deleted. |
data.version | integerCurrent set list aggregate version. |
data.createdAt | string:date-timeISO 8601 timestamp when the set list was created. |
data.createdBy | stringUser identifier that created this set list. |
data.updatedAt | string:date-timeISO 8601 timestamp when the set list was last updated. |
data.updatedBy | stringUser identifier that last updated this set list. |
data.cursor | integerLatest event-ledger cursor projected into this set list record. |
meta | object |
meta.cursor | integerHighest 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.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.setListIdrequired | string:uuidSet list identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
updatesrequired | objectSet list fields to update. |
updates.title | stringSet list title. |
updates.items | libraryItem | break[]Ordered set list entries. Each entry uses type "libraryItem" or type "break" to determine its shape. |
updates.items[].idrequired | string:uuidSet 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[].setListItemId | string:uuidReusable set list item identifier. Required when type is "libraryItem". |
updates.items[].title | stringlibraryItem: 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[].durationSeconds | integerlibraryItem: 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[].printTitle | stringOptional per-set print title override. |
updates.items[].notes | stringOptional notes for this set list entry. |
updates.visibility | object | nullUpdated visibility rules, or null to clear them. |
updates.visibility.groupIds | string:uuid[] |
updates.visibility.userIds | string:uuid[] |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative 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.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.setListIdrequired | string:uuidSet list identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |