← Volver al índice de esquemas
CommitBeneficiaryImportResponse
Respuesta de `POST /v1/beneficiaries/imports/{id}/commit` (HTTP 202). Envoltorio JSON:API mínimo con el ID de la importación y su nuevo estado (`committing`). La confirmación lo ejecuta el trabajador; sondea `GET /v1/beneficiaries/imports/{id}` hasta `completed` o `failed`.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | object | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type* | string | Tipo del recurso JSON:API. Siempre `beneficiary_import`. |
id* | string | Identificador numérico del trabajo de importación (expresado como string). |
attributes* | object | Atributos de la importación devueltos tras la confirmación (estado de transición). |
status* | string | Nuevo estado tras encolar la confirmación. El único valor posible es `committing`. |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec. |
timezone* | string | Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
POST /v1/beneficiaries/imports/{id}/commit