Triggers asynchronous processing of a batch file.
POST
/api/transactions/batch-file/{id}/trigger-processing
deprecated
No permission required.
The batch file must be in `Ready` or `Pending` status. A distributed event is published to initiate the background processing workflow. Processing progress is reflected in the batch file's status and transaction counters.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The batch file ID to process. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 Processing triggered successfully.
| Field | Type | Description |
|---|
This response has no documented body fields.
400 The batch file is not in a valid state for processing.
| Field | Type | Description |
|---|
This response has no documented body fields.
404 No batch file exists with the specified ID.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.