Platform · Published API
Exposures
A decision, taken once, that one screen may leave this company — which columns of it, which rows of it, and whether anything may be written back. Nothing is reachable from outside until it is published here, and there is no "publish everything".
/api/platform/api-exposuresPublished as /api/v1/api-exposuresOverview
| 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 › Exposures 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.api_exposures · 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/api-exposuresList exposures
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"module_key": "text",
"resource_key": "text",
"allow_read": true,
"allow_create": true,
"allow_update": true,
"allow_delete": true,
"column_mode": "listed",
"columns": [],
"row_filter": {}
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/api-exposures?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/api-exposures/{id}Read one exposure
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"module_key": "text",
"resource_key": "text",
"allow_read": true,
"allow_create": true,
"allow_update": true,
"allow_delete": true,
"column_mode": "listed",
"columns": [],
"row_filter": {}
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/api-exposures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-exposuresCreate a exposure
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Published as — What the outside world calls this. It is the URL and the MCP tool name — deliberately separate from the screen name, so renaming a screen here never breaks somebody's integration. |
name | text | Yes | Name |
description | text | No | What it is — Read by a developer in the OpenAPI document and by a model in the MCP tool list. Worth writing: it is the only place anybody is told that "orders" here means purchase orders. |
module_key | text | Yes | Module — Pick from the picker in API Studio rather than typing — the list is read out of the product itself. |
resource_key | text | Yes | Screen |
allow_read | boolean | No | May be read |
allow_create | boolean | No | May be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen. |
allow_update | boolean | No | May be changed |
allow_delete | boolean | No | May be deleted |
column_mode | text | No | Columns — listed — only what is named below, and nothing else is ever sent. all — every column. all_but — everything except what is named below. Allowed: listed all all_but |
columns | _text | No | Column names — Comma separated. A misspelt name here is silent, so use the picker in API Studio where you can see what the screen actually has. |
row_filter | jsonb | No | Rows that may travel — The same filter every list screen speaks: {"col":"status","op":"eq","value":"posted"}. Applied on the server on every call, and a filter the caller sends is ANDed underneath it — nothing they can send widens it. |
max_rows | integer | No | Most rows per call |
mcp_enabled | boolean | No | Offer as an MCP tool |
mcp_hint | text | No | What to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used. |
status | text | No | Status — Only an active exposure is reachable. A draft is a decision somebody is still writing. Allowed: draft active suspended retired |
Sample body
{
"code": "COD-000001",
"name": "Example",
"module_key": "text",
"resource_key": "text",
"description": "text",
"allow_read": true,
"allow_create": true,
"allow_update": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"module_key": "text",
"resource_key": "text",
"allow_read": true,
"allow_create": true,
"allow_update": true,
"allow_delete": true,
"column_mode": "listed",
"columns": [],
"row_filter": {}
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-exposures" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","module_key":"text","resource_key":"text","description":"text","allow_read":true,"allow_create":true,"allow_update":true}'PUT/api/platform/api-exposures/{id}Change a exposure
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 | Published as — What the outside world calls this. It is the URL and the MCP tool name — deliberately separate from the screen name, so renaming a screen here never breaks somebody's integration. |
name | text | Yes | Name |
description | text | No | What it is — Read by a developer in the OpenAPI document and by a model in the MCP tool list. Worth writing: it is the only place anybody is told that "orders" here means purchase orders. |
module_key | text | Yes | Module — Pick from the picker in API Studio rather than typing — the list is read out of the product itself. |
resource_key | text | Yes | Screen |
allow_read | boolean | No | May be read |
allow_create | boolean | No | May be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen. |
allow_update | boolean | No | May be changed |
allow_delete | boolean | No | May be deleted |
column_mode | text | No | Columns — listed — only what is named below, and nothing else is ever sent. all — every column. all_but — everything except what is named below. Allowed: listed all all_but |
columns | _text | No | Column names — Comma separated. A misspelt name here is silent, so use the picker in API Studio where you can see what the screen actually has. |
row_filter | jsonb | No | Rows that may travel — The same filter every list screen speaks: {"col":"status","op":"eq","value":"posted"}. Applied on the server on every call, and a filter the caller sends is ANDed underneath it — nothing they can send widens it. |
max_rows | integer | No | Most rows per call |
mcp_enabled | boolean | No | Offer as an MCP tool |
mcp_hint | text | No | What to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used. |
status | text | No | Status — Only an active exposure is reachable. A draft is a decision somebody is still writing. Allowed: draft active suspended retired |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"module_key": "text",
"resource_key": "text",
"allow_read": true,
"allow_create": true,
"allow_update": true,
"allow_delete": true,
"column_mode": "listed",
"columns": [],
"row_filter": {}
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/api-exposures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/api-exposures/{id}Delete a exposure
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/api-exposures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-exposures/{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/api-exposures/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 exposure, 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 |
code | text | read, write | Published as — What the outside world calls this. It is the URL and the MCP tool name — deliberately separate from the screen name, so renaming a screen here never breaks somebody's integration. |
name | text | read, write | Name |
description | text | read, write | What it is — Read by a developer in the OpenAPI document and by a model in the MCP tool list. Worth writing: it is the only place anybody is told that "orders" here means purchase orders. |
module_key | text | read, write | Module — Pick from the picker in API Studio rather than typing — the list is read out of the product itself. |
resource_key | text | read, write | Screen |
allow_read | boolean | read, write | May be read |
allow_create | boolean | read, write | May be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen. |
allow_update | boolean | read, write | May be changed |
allow_delete | boolean | read, write | May be deleted |
column_mode | text | read, write | Columns — listed — only what is named below, and nothing else is ever sent. all — every column. all_but — everything except what is named below. Allowed: listed all all_but |
columns | _text | read, write | Column names — Comma separated. A misspelt name here is silent, so use the picker in API Studio where you can see what the screen actually has. |
row_filter | jsonb | read, write | Rows that may travel — The same filter every list screen speaks: {"col":"status","op":"eq","value":"posted"}. Applied on the server on every call, and a filter the caller sends is ANDed underneath it — nothing they can send widens it. |
max_rows | integer | read, write | Most rows per call |
mcp_enabled | boolean | read, write | Offer as an MCP tool |
mcp_hint | text | read, write | What to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used. |
status | text | read, write | Status — Only an active exposure is reachable. A draft is a decision somebody is still writing. Allowed: draft active suspended retired |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
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 › Exposures 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.