Create an export job

Módulo Platform

POST/export-jobsexportJobs.create

An export of a list or report, subject to data loss prevention rules. Creates an export job. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad data.export.run.
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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ExportJobCreate

exportJobs.create: ExportJobCreate
Campo	Tipo	Obligatorio	Descripción
source_label	string	Sí	What is exported, as a saved view or report URN.Restricciones: length 1 to 300
export_format	ExportFormat	Sí	Export file format.Restricciones: one of "CSV", "XLSX", "PDF"
columns	array of string	Sí	Columns the export contains, as app.table.column.

{
  "source_label": "urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "export_format": "CSV",
  "columns": [
    "app.vendors.name"
  ]
}

Respuesta 201: ExportJob

exportJobs.create: ExportJob
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the export job.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
source_label	string	Sí	What is exported, as a saved view or report URN.Restricciones: length 1 to 300
export_format	ExportFormat	Sí	Export file format.Restricciones: one of "CSV", "XLSX", "PDF"
classification	Classification	Sí	Column classification (Section 8.3).Restricciones: one of "Public", "Internal", "Confidential", "Restricted"
watermark	boolean	Sí	True for Confidential and Restricted exports: PDFs and images carry the viewer email and time.
export_status	"Queued" \| "Rendering" \| "Ready" \| "Failed" \| "Expired"	Sí	Export progress.
storage_object_path	string \| null	Sí	Object path of the file once ready.Restricciones: length 1 to 1024
row_count	integer \| null	Sí	Rows exported.Restricciones: range 0 to any
expires_at	string (date-time) \| null	Sí	When the download link stops working.

{
  "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",
  "source_label": "urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "export_format": "CSV",
  "classification": "Restricted",
  "watermark": false,
  "export_status": "Queued",
  "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/exports/vendors.csv",
  "row_count": 120,
  "expires_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/export-jobs" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"source_label":"urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","export_format":"CSV","columns":["app.vendors.name"]}'

const { data } = await xos.exportJobs.create({
    "source_label": "urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "export_format": "CSV",
    "columns": [
      "app.vendors.name"
    ]
  });

response = xos.export_jobs.create({"source_label": "urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "export_format": "CSV", "columns": ["app.vendors.name"]})

xos export-jobs create --data '{"source_label":"urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","export_format":"CSV","columns":["app.vendors.name"]}'