Get a std emergency code
Módulo Canon
GET/canon/std/emergency-codes/{code}canonStdEmergencyCodes.get
An emergency code. Standard Library row, copied into each new org as editable org data. Returns one std emergency code with its `ETag`. A std emergency code 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 |
|---|---|---|---|
| code | 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: StdEmergencyCode
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| code | StdCode | Sí | Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label | string | Sí | Code name.Restricciones: length 1 to 200 |
| emergency | string | Sí | Response procedure.Restricciones: length 1 to 20000 |
| swatch | string | Sí | Design token of the swatch.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| sort_order | integer | Sí | Order of first appearance in the Playbook.Restricciones: range 0 to any |
{
"code": "SOP-001",
"label": "Medical Assist",
"emergency": "Dispatch the medical team to the location.",
"swatch": "ecode-red",
"sort_order": 1
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/std/emergency-codes/SOP-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonStdEmergencyCodes.get("SOP-001");response = xos.canon_std_emergency_codes.get("SOP-001")xos canon-std-emergency-codes get SOP-001