Saltar al contenido

Restore a deleted item

Módulo Platform

POST/trash/restoretrashItems.restore

Restores a soft-deleted row within its retention period, as the caller (app.restore_trash_item): the table's own update rules decide. Rows that reference it and were deleted with it come back too. A row past retention answers 422 (trash_restore_expired), a live row 422 (trash_not_deleted). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad work.record.write.
  • Alcances de OAuth: work.
  • 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: RestoreRequest

trashItems.restore: RestoreRequest
CampoTipoObligatorioDescripción
subject_urnstringSíRestricciones: length 1 to any
{
  "subject_urn": "urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: TrashRestoreResult

trashItems.restore: TrashRestoreResult
CampoTipoObligatorioDescripción
subject_urnstringSíURN of the restored row.
subject_tablestringSíTable of the restored row.
subject_idstring (uuid)SíIdentifier of the restored row.
rows_restoredintegerSíRows restored: the row and the rows that reference it and were deleted with it.Restricciones: range 1 to any
{
  "subject_urn": "urn:xpms:budgets:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "subject_table": "budgets",
  "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rows_restored": 2
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/trash/restore" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"subject_urn":"urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.trashItems.restore({
    "subject_urn": "urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.trash_items.restore({"subject_urn": "urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos trash-items restore --data '{"subject_urn":"urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'