Skip to main content
POST
/
v1
/
export-jobs
/
{jobId}
/
cancel
Cancel an export job
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/export-jobs/{jobId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "bytesWritten": 123,
  "createdAt": "<string>",
  "downloadUrl": "<string>",
  "error": "<string>",
  "expiresAt": "<string>",
  "fileName": "<string>",
  "finishedAt": "<string>",
  "format": "<string>",
  "id": "<string>",
  "recordsWritten": 123,
  "reportType": "<string>",
  "startedAt": "<string>",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Request-Id
string

A unique identifier for tracing the request across services.

​
X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Path Parameters

​
jobId
string
required

Export Job ID

Response

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

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

​
bytesWritten
integer
​
createdAt
string
​
downloadUrl
string
​
error
string
​
expiresAt
string
​
fileName
string
​
finishedAt
string
​
format
string
​
id
string
​
recordsWritten
integer
​
reportType
string
​
startedAt
string
​
status
string