Saltar al contenido

Get an import row result

Módulo Platform

GET/import-row-results/{id}importRowResults.get

The validation result of one imported row, with a reason per cell. Returns one import row result with its `ETag`. A import row result the caller may not see returns 404.

  • Requiere la capacidad org.settings.read.
  • Alcances de OAuth: org.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

importRowResults.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the import row result.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: ImportRowResult

importRowResults.get: ImportRowResult
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the import row result.
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_job_idstring (uuid)SíIdentifier of the import job.
row_stateImportRowStateSíImport row result state.Restricciones: one of "Valid", "Invalid", "Written", "Refused", "Skipped"
reasonstring | nullSíWhy the row is invalid or refused.Restricciones: length 1 to 300
import_batch_idstring (uuid) | nullSíIdentifier of the batch that wrote the row; set exactly when the row is written.
sheet_namestringSíSource sheet.Restricciones: length 1 to 300
row_numberintegerSíOne-based row number in the sheet, as the person sees it.Restricciones: range 1 to any
target_tablestring | nullSíTable the row was written to.Restricciones: pattern ^[a-z][a-z0-9_]*$
target_idstring (uuid) | nullSíIdentifier of the row written, created, updated or merged into.
write_action"Created" | "Updated" | "Merged" | nullSíWhat the write did.
before_imageobject | nullSíThe columns an update or merge changed, as they were before the write; undo restores them.
undo_outcome"Reverted" | "Kept" | nullSíOutcome when the batch was undone.
undo_reasonstring | nullSíWhy a row was kept: the later edit or the dependent row.Restricciones: length 1 to 2000
{
  "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_job_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "row_state": "Valid",
  "reason": "Unknown counterparty type.",
  "import_batch_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "sheet_name": "Vendors",
  "row_number": 2,
  "target_table": "records",
  "target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "write_action": "Created",
  "before_image": {
    "type": "doc"
  },
  "undo_outcome": "Reverted",
  "undo_reason": "Edited after the import."
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/import-row-results/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.importRowResults.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.import_row_results.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos import-row-results get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f