Master data · Records
Merge requests
Read and maintain merge requests records (mdm.merge_requests).
Type REST5 operationsBase path
/api/mdm/merge-requestsPublished as /api/v1/merge-requestsOverview
| Package | Master data |
|---|---|
| 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 Master data › Merge requests 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 | mdm.merge_requests · 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
5 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mdm/merge-requestsList merge requests
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",
"request_no": "REQ-000001",
"entity": "text",
"survivor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"merged_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"survivor_label": "text",
"merged_label": "text",
"reason": "text",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"preview": {},
"moved": {},
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mdm/merge-requests?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mdm/merge-requests/{id}Read one merge requests
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",
"request_no": "REQ-000001",
"entity": "text",
"survivor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"merged_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"survivor_label": "text",
"merged_label": "text",
"reason": "text",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"preview": {},
"moved": {},
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mdm/merge-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mdm/merge-requestsCreate a merge requests
Request body
The record as JSON. Fields marked Yes are required.
No body.
Sample body
{}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"entity": "text",
"survivor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"merged_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"survivor_label": "text",
"merged_label": "text",
"reason": "text",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"preview": {},
"moved": {},
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mdm/merge-requests" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'PUT/api/mdm/merge-requests/{id}Change a merge requests
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.
No body.
Sample body
{}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"entity": "text",
"survivor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"merged_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"survivor_label": "text",
"merged_label": "text",
"reason": "text",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"preview": {},
"moved": {},
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mdm/merge-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'DELETE/api/mdm/merge-requests/{id}Delete a merge requests
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/mdm/merge-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a merge requests, 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 |
request_no | text | read only | Request no |
entity | text | read only | Entity |
survivor_id | uuid | read only | Survivor id |
merged_id | uuid | read only | Merged id |
survivor_label | text | read only | Survivor label |
merged_label | text | read only | Merged label |
reason | text | read only | Reason |
candidate_id | uuid | read only | Candidate id |
status | text | read only | Status |
preview | jsonb | read only | Preview |
moved | jsonb | read only | Moved |
requested_by | uuid | read only | Requested by |
requested_at | timestamp with time zone | read only | Requested at |
decided_by | uuid | read only | Decided by |
decided_at | timestamp with time zone | read only | Decided at |
decision_note | text | read only | Decision note |
applied_at | timestamp with time zone | read only | Applied at |
reversed_by | uuid | read only | Reversed by |
reversed_at | timestamp with time zone | read only | Reversed at |
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 Master data › Merge requests 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.