Platform · Legacy Migration
Migration Batches
Every consignment of rows, with what became of each.
/api/platform/migration-batchesPublished as /api/v1/migration-batchesDownload specification (OpenAPI 3.1) Screen: Migration Batches
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 › Migration Batches 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 | migrate.batch_history · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/migration-batchesList migration batches
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"batch_no": "BAT-000001",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_code": "OBJ-000001",
"data_class": "text",
"file_name": "Example",
"row_count": 10,
"staged": 10,
"validated": 10,
"rejected": 10,
"loaded": 10,
"archived": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/migration-batches?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/migration-batches/{id}Read one migration batches
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"batch_no": "BAT-000001",
"source_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_code": "OBJ-000001",
"data_class": "text",
"file_name": "Example",
"row_count": 10,
"staged": 10,
"validated": 10,
"rejected": 10,
"loaded": 10,
"archived": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/migration-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/migration-batchesPost migration batches
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/migration-batches" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/migration-batches/{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/migration-batches/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/migration-batches/{id}Put migration batches
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/migration-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/migration-batches/{id}Delete migration batches
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/migration-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a migration batches, 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 |
org_unit_id | uuid | read only | Org unit id |
batch_no | text | read only | Batch no |
source_id | uuid | read only | Source id |
object_id | uuid | read only | Object id |
object_code | text | read only | Object code |
data_class | text | read only | Data class |
file_name | text | read only | File name |
row_count | integer | read only | Row count |
staged | integer | read only | Staged |
validated | integer | read only | Validated |
rejected | integer | read only | Rejected |
loaded | integer | read only | Loaded |
archived | integer | read only | Archived |
status | text | read only | Status |
summary | text | read only | Summary |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
kind | text | read only | Kind |
as_of | date | read only | As of |
source_drive_id | uuid | read only | Source drive id |
source_path | text | read only | Source path |
source_external_id | text | read only | Source external id |
chunk_no | integer | read only | Chunk no |
first_row | integer | read only | First row |
last_row | integer | read only | Last row |
ingest_run_id | uuid | read only | Ingest run id |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
source_code | text | read only | Source code |
object_name | text | read only | Object name |
target_module | text | read only | Target module |
target_resource | text | read only | Target resource |
created_by_name | text | read only | Created by name |
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 › Migration Batches 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.