Platform · Batch
Job Definitions
What each job selects, what it does to what it selects, and whether it is safe to run twice.
/api/platform/batch-job-definitionsPublished as /api/v1/batch-job-definitionsDownload specification (OpenAPI 3.1) Screen: Job Definitions
Overview
| 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 › Job Definitions 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. |
| Table | batch.job_definitions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/batch-job-definitionsList job definitions
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"module": "accounting",
"category": "text",
"description": "text",
"selects": "text",
"acts": "text",
"handler": "text",
"parameters": {},
"supports_dry_run": true,
"is_idempotent": true,
"repeat_note": "text",
"requires_role": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/batch-job-definitions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/batch-job-definitions/{id}Read one batch job definitions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"module": "accounting",
"category": "text",
"description": "text",
"selects": "text",
"acts": "text",
"handler": "text",
"parameters": {},
"supports_dry_run": true,
"is_idempotent": true,
"repeat_note": "text",
"requires_role": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/batch-job-definitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch-job-definitionsCreate a batch job definitions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
module | text | Yes | Module Allowed: accounting scm hrms crm mfg ehr slcm ats platform |
category | text | No | Category |
description | text | No | Description |
selects | text | No | Selects |
acts | text | No | Acts |
handler | text | No | Handler |
supports_dry_run | boolean | No | Can be rehearsed |
is_idempotent | boolean | No | Safe to repeat |
repeat_note | text | No | If repeated |
requires_role | text | No | Requires role |
is_active | boolean | No | Active |
sort_order | integer | No | Order |
Sample body
{
"code": "COD-000001",
"name": "Example",
"module": "accounting",
"category": "text",
"description": "text",
"selects": "text",
"acts": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"module": "accounting",
"category": "text",
"description": "text",
"selects": "text",
"acts": "text",
"handler": "text",
"parameters": {},
"supports_dry_run": true,
"is_idempotent": true,
"repeat_note": "text",
"requires_role": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/batch-job-definitions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","module":"accounting","category":"text","description":"text","selects":"text","acts":"text"}'PUT/api/platform/batch-job-definitions/{id}Change a batch job definitions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
module | text | Yes | Module Allowed: accounting scm hrms crm mfg ehr slcm ats platform |
category | text | No | Category |
description | text | No | Description |
selects | text | No | Selects |
acts | text | No | Acts |
handler | text | No | Handler |
supports_dry_run | boolean | No | Can be rehearsed |
is_idempotent | boolean | No | Safe to repeat |
repeat_note | text | No | If repeated |
requires_role | text | No | Requires role |
is_active | boolean | No | Active |
sort_order | integer | No | Order |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"module": "accounting",
"category": "text",
"description": "text",
"selects": "text",
"acts": "text",
"handler": "text",
"parameters": {},
"supports_dry_run": true,
"is_idempotent": true,
"repeat_note": "text",
"requires_role": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/batch-job-definitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/batch-job-definitions/{id}Delete a batch job definitions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/batch-job-definitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/batch-job-definitions/{id}/copyCopy
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):
overrides, preview, withLinesResponse
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-job-definitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a batch job definitions, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Code |
name | text | read, write | Name |
module | text | read, write | Module Allowed: accounting scm hrms crm mfg ehr slcm ats platform |
category | text | read, write | Category |
description | text | read, write | Description |
selects | text | read, write | Selects |
acts | text | read, write | Acts |
handler | text | read, write | Handler |
parameters | jsonb | read only | Parameters |
supports_dry_run | boolean | read, write | Can be rehearsed |
is_idempotent | boolean | read, write | Safe to repeat |
repeat_note | text | read, write | If repeated |
requires_role | text | read, write | Requires role |
max_records | integer | read only | Max records |
typical_runtime_note | text | read only | Typical runtime note |
is_default | boolean | read only | Is default |
is_active | boolean | read, write | Active |
sort_order | integer | read, write | Order |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
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 › Job Definitions 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.