TRANXACT.AI Help

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-requests

Download specification (OpenAPI 3.1)

Overview

PackageMaster data
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablemdm.merge_requests · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
request_notextread onlyRequest no
entitytextread onlyEntity
survivor_iduuidread onlySurvivor id
merged_iduuidread onlyMerged id
survivor_labeltextread onlySurvivor label
merged_labeltextread onlyMerged label
reasontextread onlyReason
candidate_iduuidread onlyCandidate id
statustextread onlyStatus
previewjsonbread onlyPreview
movedjsonbread onlyMoved
requested_byuuidread onlyRequested by
requested_attimestamp with time zoneread onlyRequested at
decided_byuuidread onlyDecided by
decided_attimestamp with time zoneread onlyDecided at
decision_notetextread onlyDecision note
applied_attimestamp with time zoneread onlyApplied at
reversed_byuuidread onlyReversed by
reversed_attimestamp with time zoneread onlyReversed at
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Master data › Merge requests for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.