TRANXACT.AI Help

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".

Type REST6 operationsBase path /api/platform/api-exposuresPublished as /api/v1/api-exposures

Download specification (OpenAPI 3.1) Screen: Exposures

Overview

PackagePlatform
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 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.
Tableplatform.api_exposures · 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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/api-exposuresList exposures

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
codetextYesPublished 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.
nametextYesName
descriptiontextNoWhat 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_keytextYesModule — Pick from the picker in API Studio rather than typing — the list is read out of the product itself.
resource_keytextYesScreen
allow_readbooleanNoMay be read
allow_createbooleanNoMay be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen.
allow_updatebooleanNoMay be changed
allow_deletebooleanNoMay be deleted
column_modetextNoColumns — 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_textNoColumn 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_filterjsonbNoRows 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_rowsintegerNoMost rows per call
mcp_enabledbooleanNoOffer as an MCP tool
mcp_hinttextNoWhat to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used.
statustextNoStatus — 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

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.

FieldTypeRequiredDescription
codetextYesPublished 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.
nametextYesName
descriptiontextNoWhat 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_keytextYesModule — Pick from the picker in API Studio rather than typing — the list is read out of the product itself.
resource_keytextYesScreen
allow_readbooleanNoMay be read
allow_createbooleanNoMay be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen.
allow_updatebooleanNoMay be changed
allow_deletebooleanNoMay be deleted
column_modetextNoColumns — 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_textNoColumn 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_filterjsonbNoRows 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_rowsintegerNoMost rows per call
mcp_enabledbooleanNoOffer as an MCP tool
mcp_hinttextNoWhat to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used.
statustextNoStatus — 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

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/platform/api-exposures/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/api-exposures/{id}/copyCopy

Path parameters

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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writePublished 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.
nametextread, writeName
descriptiontextread, writeWhat 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_keytextread, writeModule — Pick from the picker in API Studio rather than typing — the list is read out of the product itself.
resource_keytextread, writeScreen
allow_readbooleanread, writeMay be read
allow_createbooleanread, writeMay be created — A create through the API goes through the same validation, numbering and posting rules as one typed on screen.
allow_updatebooleanread, writeMay be changed
allow_deletebooleanread, writeMay be deleted
column_modetextread, writeColumns — 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_textread, writeColumn 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_filterjsonbread, writeRows 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_rowsintegerread, writeMost rows per call
mcp_enabledbooleanread, writeOffer as an MCP tool
mcp_hinttextread, writeWhat to tell a model — Only where a model needs telling something a developer would not. Left blank, the description above is used.
statustextread, writeStatus — Only an active exposure is reachable. A draft is a decision somebody is still writing.
Allowed: draft active suspended retired
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
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 Platform › Exposures 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.