Platform · Integration
Pipeline Runs
What each run read, staged and failed to stage. An inbound run is checked, approved by somebody other than the person who fetched it, and loaded through the target screen, or rejected and discarded. Whether an outbound destination can be reached is shown by its connection's health, on Connections.
/api/platform/pipeline-runsPublished as /api/v1/pipeline-runsOverview
| 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 › Pipeline Runs 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 | platform.pipeline_runs · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/pipeline-runsList pipeline runs
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",
"pipeline_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_no": "RUN-000001",
"started_at": "2026-10-30T09:00:00Z",
"finished_at": "2026-10-30T09:00:00Z",
"duration_ms": 10,
"status": "draft",
"records_read": 10,
"records_written": 10,
"records_failed": 10,
"bytes_moved": "1250.00",
"cursor_from": "text",
"cursor_to": "text",
"error": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/pipeline-runs?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/pipeline-runs/{id}Read one pipeline runs
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",
"pipeline_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_no": "RUN-000001",
"started_at": "2026-10-30T09:00:00Z",
"finished_at": "2026-10-30T09:00:00Z",
"duration_ms": 10,
"status": "draft",
"records_read": 10,
"records_written": 10,
"records_failed": 10,
"bytes_moved": "1250.00",
"cursor_from": "text",
"cursor_to": "text",
"error": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/pipeline-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/pipeline-runsPost pipeline runs
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/pipeline-runs" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/pipeline-runs/{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/pipeline-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/platform/pipeline-runs/{id}Put pipeline runs
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 PUT "https://demo.tranxact.ai/api/platform/pipeline-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/pipeline-runs/{id}Delete pipeline runs
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/pipeline-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/pipeline-runs/{id}/recordsRecords
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/pipeline-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/records" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a pipeline runs, 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 |
pipeline_id | uuid | read only | Pipeline id |
run_no | text | read only | Run no |
started_at | timestamp with time zone | read only | Started at |
finished_at | timestamp with time zone | read only | Finished at |
duration_ms | integer | read only | Duration ms |
status | text | read only | Status |
records_read | integer | read only | Records read |
records_written | integer | read only | Records written |
records_failed | integer | read only | Records failed |
bytes_moved | bigint | read only | Bytes moved |
cursor_from | text | read only | Cursor from |
cursor_to | text | read only | Cursor to |
error | text | read only | Error |
triggered_by | text | read only | Triggered by |
org_unit_id | uuid | read only | Org unit id |
created_at | timestamp with time zone | read only | Created at |
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 › Pipeline Runs 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.