Saltar al contenido

Get a day sheet

Módulo Show

GET/day-sheets/{id}daySheets.get

A day sheet for one scope node and date. Returns one day sheet with its `ETag`. A day sheet the caller may not see returns 404.

  • Requiere la capacidad show.run_of_show.read.
  • Alcances de OAuth: show.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

daySheets.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the day sheet.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: DaySheet

daySheets.get: DaySheet
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the day sheet.
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.
daystring (date)SíDay the sheet covers; one sheet per project and day.
bodystringSíDay sheet content as rich text.Restricciones: length 1 to 20000
project_idstring (uuid)SíIdentifier of the project of the day sheet.
published_atstring (date-time) | nullSíWhen the day sheet was published, stamped by the database; set once by the publish action.
{
  "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",
  "day": "2026-10-08",
  "body": "Doors at 18:00. Load-out after the encore.",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "published_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/day-sheets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.daySheets.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.day_sheets.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos day-sheets get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f