Saltar al contenido

Update a lost found item

Módulo Workforce

PATCH/lost-found-items/{id}lostFoundItems.update

An item in the lost and found log, with photos as attachments and its claim state. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad safety.incident.write.
  • Alcances de OAuth: safety.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

lostFoundItems.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the lost found item.

Cuerpo de la solicitud: LostFoundItemUpdate

lostFoundItems.update: LostFoundItemUpdate
CampoTipoObligatorioDescripción
category"Wallet" | "Bag" | "Clothing" | "Electronics" | "Jewelry" | "Keys" | "Documents" | "Other"NoCategory.
descriptionstringNoDescription a claimant is checked against.Restricciones: length 1 to 1000
storage_locationstring | nullNoWhere it is held.Restricciones: length 1 to 200
{
  "category": "Wallet",
  "description": "Brown leather wallet.",
  "storage_location": "Security office locker 4"
}

Respuesta 200: LostFoundItem

lostFoundItems.update: LostFoundItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the lost found item.
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.
item_numberstringSíDisplay number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
category"Wallet" | "Bag" | "Clothing" | "Electronics" | "Jewelry" | "Keys" | "Documents" | "Other"SíCategory.
descriptionstringSíDescription a claimant is checked against.Restricciones: length 1 to 1000
found_atstring (date-time)SíWhen it was found.
found_locationstringSíWhere it was found.Restricciones: length 1 to 200
storage_locationstring | nullSíWhere it is held.Restricciones: length 1 to 200
logged_by_membership_idstring (uuid) | nullSíIdentifier of the member who logged it.
item_state"Logged" | "Claimed" | "Returned" | "Disposed"SíItem state.
{
  "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",
  "item_number": "LF-0001",
  "category": "Wallet",
  "description": "Brown leather wallet.",
  "found_at": "2026-10-08T14:30:00Z",
  "found_location": "Bar 2",
  "storage_location": "Security office locker 4",
  "logged_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "item_state": "Logged"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/lost-found-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"category":"Wallet","description":"Brown leather wallet.","storage_location":"Security office locker 4"}'
const { data, etag } = await xos.lostFoundItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "category": "Wallet",
    "description": "Brown leather wallet.",
    "storage_location": "Security office locker 4"
  }, { ifMatch: etag });
response = xos.lost_found_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"category": "Wallet", "description": "Brown leather wallet.", "storage_location": "Security office locker 4"}, if_match=etag)
xos lost-found-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"category":"Wallet","description":"Brown leather wallet.","storage_location":"Security office locker 4"}' --if-match auto