Platform · Batch
Batch Console
The job library for every module, with a rehearsal that shows which records a job would touch before it touches them.
/api/platform/batchOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Batch Console on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
POST/api/platform/batch/jobs/{id}/runJobs run
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
dryRun, parameters, schedule, backgroundResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch/jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"dryRun":"value","parameters":"value","schedule":"value","background":"value"}'GET/api/platform/batch/cadencesCadences
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch/cadences" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/batch/schedulesSchedules
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch/schedules" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch/schedulesSchedules
Request body
The keys this action reads (* = required; "one of" lists the only values):
jobId, dryRun, parameters, schedule, origin, originRefResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch/schedules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"jobId":"value","dryRun":"value","parameters":"value","schedule":"value","origin":"value","originRef":"value"}'PATCH/api/platform/batch/schedules/{id}Schedules
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
cadence, runAt, run_at, dayOfWeek, day_of_week, dayOfMonth, day_of_month, timeZone, time_zone, startsAt, starts_at; cadence one of once|every_15_min|hourly|daily|weekly|monthly|quarterly|annually|period_end|on_demandResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PATCH "https://demo.tranxact.ai/api/platform/batch/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cadence":"value","runAt":"value","run_at":"value","dayOfWeek":"value","day_of_week":"value","dayOfMonth":"value"}'POST/api/platform/batch/schedules/{id}/run-nowSchedules run now
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run-now" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/batch/schedules/{id}Schedules
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/batch/schedules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/batch/runs/{id}/itemsRuns items
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch/sets/{id}/runSets run
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
dryRun, parametersResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch/sets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"dryRun":"value","parameters":"value"}'GET/api/platform/batch/set-runs/{id}Set runs
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch/set-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/batch/catalogueCatalogue
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch/catalogue" \
-H "Authorization: Bearer $TOKEN"Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Batch Console for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.