Saltar al contenido

Commit an import

Módulo Platform

POST/import-jobs/{id}/commitimportJobs.commit

Writes the validated rows in one import batch. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

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

Parámetros de ruta y de consulta

importJobs.commit: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the import job.

Respuesta 201: ImportJob

importJobs.commit: ImportJob
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the import job.
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íIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
import_mapping_profile_idstring (uuid) | nullSíIdentifier of the saved mapping profile.
target_codestringSíImport target the rows are written to.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
source"CSV" | "XLSX" | "XLS" | "Google Sheets"SíSource format.
original_filenamestringSíFile name as uploaded.Restricciones: length 1 to 255
storage_object_pathstringSíObject path of the uploaded file in the tenant import bucket.Restricciones: length 1 to 1024
import_status"Uploaded" | "Detected" | "Mapped" | "Validated" | "Committing" | "Committed" | "Undone" | "Failed" | "Canceled"SíWizard progress.
mapping_confirmed_atstring (date-time) | nullSíWhen the person confirmed every column mapping; nothing is validated before it.
{
  "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",
  "import_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "target_code": "vendors",
  "source": "CSV",
  "original_filename": "vendors-2026.xlsx",
  "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx",
  "import_status": "Uploaded",
  "mapping_confirmed_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/import-jobs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/commit" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.importJobs.commit("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.import_jobs.commit("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos import-jobs commit 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f