Get a weather alert
Módulo Workforce
GET/weather-alerts/{id}weatherAlerts.get
A weather alert raised by a reading at the highest level met, cleared when readings fall below every level. Returns one weather alert with its `ETag`. A weather alert the caller may not see returns 404.
- Requiere la capacidad safety.incident.read.
- Alcances de OAuth: safety.
- 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 |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the weather alert. |
| 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: WeatherAlert
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the weather alert. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| hazard | "Wind" | "Lightning" | "Heat" | Sí | Hazard. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Sí | Level met. |
| weather_reading_id | string (uuid) | Sí | Identifier of the reading that raised it. |
| issued_at | string (date-time) | Sí | When it was raised. |
| cleared_at | string (date-time) | null | Sí | When it cleared. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hazard": "Wind",
"alert_level": "Monitor",
"weather_reading_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"issued_at": "2026-10-08T14:30:00Z",
"cleared_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/weather-alerts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.weatherAlerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.weather_alerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos weather-alerts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f