Saltar al contenido

Create a weather alert role

Módulo Workforce

POST/weather-alert-rolesweatherAlertRoles.create

A canon role the emergency plan names for a weather level; people assigned it on the project are alerted. Creates a weather alert role. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad safety.emergency_code.write.
  • Alcances de OAuth: safety.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: WeatherAlertRoleCreate

weatherAlertRoles.create: WeatherAlertRoleCreate
CampoTipoObligatorioDescripción
project_idstring (uuid)SíIdentifier of the project.
alert_level"Monitor" | "Restrict" | "Evacuate"SíLevel.
role_codestringSíCanon role notified.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "alert_level": "Monitor",
  "role_code": "5000.01.01"
}

Respuesta 201: WeatherAlertRole

weatherAlertRoles.create: WeatherAlertRole
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the weather alert role.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
project_idstring (uuid)SíIdentifier of the project.
alert_level"Monitor" | "Restrict" | "Evacuate"SíLevel.
role_codestringSíCanon role notified.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "alert_level": "Monitor",
  "role_code": "5000.01.01"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/weather-alert-roles" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","alert_level":"Monitor","role_code":"5000.01.01"}'
const { data } = await xos.weatherAlertRoles.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "alert_level": "Monitor",
    "role_code": "5000.01.01"
  });
response = xos.weather_alert_roles.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "alert_level": "Monitor", "role_code": "5000.01.01"})
xos weather-alert-roles create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","alert_level":"Monitor","role_code":"5000.01.01"}'