Get a weather threshold
Módulo Workforce
GET/weather-thresholds/{id}weatherThresholds.get
A weather action threshold of a project: one value per hazard and level, with its emergency plan source. Returns one weather threshold with its `ETag`. A weather threshold 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 threshold. |
| 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: WeatherThreshold
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the weather threshold. |
| 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. |
| threshold_value | number | Sí | Value that triggers the level.Restricciones: range 0 to 200 |
| unit | "mph" | "mi" | "F" | Sí | Unit: mph for wind, mi for lightning distance, F for heat index. |
| comparison | "At or Above" | "At or Below" | Sí | At or Above for wind and heat, At or Below for lightning. |
| source_note | string | Sí | Where the value comes from.Restricciones: length 1 to 300 |
{
"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",
"threshold_value": 30,
"unit": "mph",
"comparison": "At or Above",
"source_note": "Emergency plan 4.2"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/weather-thresholds/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.weatherThresholds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.weather_thresholds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos weather-thresholds get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f