Saltar al contenido

Create a run of show

Módulo Show

POST/run-of-showrunsOfShow.create

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

  • Requiere la capacidad show.run_of_show.write.
  • Alcances de OAuth: show.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: RunOfShowCreate

runsOfShow.create: RunOfShowCreate
CampoTipoObligatorioDescripción
scope_node_idstring (uuid) | nullNoIdentifier of the show scope node.
namestringSíRun of show title.Restricciones: length 1 to 300
show_datestring (date)SíShow date.
project_idstring (uuid)SíIdentifier of the project of the running order.
record_idstring (uuid) | nullNoIdentifier of the schedule record the running order belongs to, in the same project.
{
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Saturday Main Stage",
  "show_date": "2026-10-08",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: RunOfShow

runsOfShow.create: RunOfShow
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the run of show.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
scope_node_idstring (uuid) | nullSíIdentifier of the show scope node.
namestringSíRun of show title.Restricciones: length 1 to 300
show_datestring (date)SíShow date.
project_idstring (uuid)SíIdentifier of the project of the running order.
record_idstring (uuid) | nullSíIdentifier of the schedule record the running order belongs to, in the same project.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Saturday Main Stage",
  "show_date": "2026-10-08",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/run-of-show" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Saturday Main Stage","show_date":"2026-10-08","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.runsOfShow.create({
    "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "name": "Saturday Main Stage",
    "show_date": "2026-10-08",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.runs_of_show.create({"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Saturday Main Stage", "show_date": "2026-10-08", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos runs-of-show create --data '{"scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Saturday Main Stage","show_date":"2026-10-08","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'