Get a std radio channel
Módulo Canon
GET/canon/std/radio-channels/{record_id}canonStdRadioChannels.get
A radio channel plan entry. Standard Library row, copied into each new org as editable org data. Returns one std radio channel with its `ETag`. A std radio channel the caller may not see returns 404.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| record_id | StdCode | Sí | Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| fields | Fields | No | Sparse 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: StdRadioChannel
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| record_id | StdCode | Sí | Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| channel | number | null | Sí | Radio channel number. |
| zone | number | null | Sí | Radio zone. |
| assignment | string | null | Sí | Who the channel is assigned to.Restricciones: length 1 to 300 |
| department | string | null | Sí | Department as the sheet names it.Restricciones: length 1 to 200 |
| category | string | null | Sí | Category code or name as the sheet gives it.Restricciones: length 1 to 200 |
| sub_category | string | null | Sí | Sub-category as the sheet names it.Restricciones: length 1 to 200 |
| status | string | null | Sí | Row status in the sheet.Restricciones: length 1 to 200 |
| notes | string | null | Sí | Notes in the sheet.Restricciones: length 1 to 20000 |
{
"record_id": "SOP-001",
"channel": 1,
"zone": 1,
"assignment": "Emergency",
"department": "5000 Production",
"category": "5000.05.02",
"sub_category": "Overhead Rigging",
"status": "Active",
"notes": "Primary life safety and incident response"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/std/radio-channels/SOP-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonStdRadioChannels.get("SOP-001");response = xos.canon_std_radio_channels.get("SOP-001")xos canon-std-radio-channels get SOP-001