Get export job status

Use this endpoint to retrieve the status of a specific export job.

GET /v1/export-jobs/{jobId}

Get export job status

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/export-jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "bytesWritten": 524288,
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "expiresAt": "2025-01-16T10:30:00Z",
  "format": "CSV",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "recordsWritten": 4250,
  "reportType": "MATCHED",
  "status": "SUCCEEDED",
  "downloadUrl": "/v1/export-jobs/550e8400-e29b-41d4-a716-446655440000/download",
  "error": "timeout exceeded",
  "fileName": "matched_report_2025-01-31.csv",
  "finishedAt": "2025-01-15T10:35:00Z",
  "startedAt": "2025-01-15T10:30:05Z"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

jobId · string<uuid> · requerido

Export Job ID

Respuesta

200

application/json

Indicates that the request was successful and the response contains the expected data.

bytesWritten · integer<int64> · requerido

Size of the export file in bytes.

Ejemplo:

524288

contextId · string<uuid> · requerido

Identifier of the reconciliation context this export was queued for (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string<date-time> · requerido

Timestamp when the job was created (RFC 3339, UTC).

Ejemplo:

"2025-01-15T10:30:00Z"

expiresAt · string<date-time> · requerido

Timestamp after which the export file is purged and no longer downloadable (RFC 3339, UTC).

Ejemplo:

"2025-01-16T10:30:00Z"

format · enum<string> · requerido

File format of the exported report.

Opciones disponibles: CSV, JSON, XML, PDF

Ejemplo:

"CSV"

id · string<uuid> · requerido

Identifier of the export job (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

recordsWritten · integer<int64> · requerido

Number of records written to the export file.

Ejemplo:

4250

reportType · enum<string> · requerido

Type of report this job exports.

Opciones disponibles: MATCHED, UNMATCHED, SUMMARY, VARIANCE, EXCEPTIONS, MATCHES, UNMATCHED_TRANSACTIONS

Ejemplo:

"MATCHED"

status · enum<string> · requerido

Current lifecycle status: QUEUED (waiting), RUNNING (in progress), SUCCEEDED (complete and downloadable), FAILED (errored), EXPIRED (file no longer available), CANCELED (cancelled by user).

Opciones disponibles: QUEUED, RUNNING, SUCCEEDED, FAILED, EXPIRED, CANCELED

Ejemplo:

"SUCCEEDED"

downloadUrl · string

API path of the download endpoint (GET it for a presigned file URL), present only when the job has succeeded and the file is still available.

Ejemplo:

"/v1/export-jobs/550e8400-e29b-41d4-a716-446655440000/download"

error · string

Failure reason, present only when the job status is FAILED.

Ejemplo:

"timeout exceeded"

fileName · string

Generated export file name, present once the job has produced a file.

Ejemplo:

"matched_report_2025-01-31.csv"

finishedAt · string<date-time>

Timestamp when processing finished, present once the job reaches a terminal state (RFC 3339, UTC).

Ejemplo:

"2025-01-15T10:35:00Z"

startedAt · string<date-time>

Timestamp when processing started, present once the job has begun running (RFC 3339, UTC).

Ejemplo:

"2025-01-15T10:30:05Z"