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".
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Published API
- Screen: Exposures
Address in the console: /platform/api-exposures
List · 11 columns · 16 fields on its form · 4 of them required
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Published as | Code | code |
| Name | Text | name |
| Module | Status | module_key |
| Screen | Code | resource_key |
| Access | Status | access_summary |
| Columns | Text | column_summary |
| Max rows | Number | max_rows |
| Keys | Number | granted_to |
| Calls (30d) | Number | calls_30d |
| Last called | Date and time | last_called_at |
| Status | Status | status |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Published as required | Text | 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 required | Text | ||
| What it is | Long text | 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 required | Text | Pick from the picker in API Studio rather than typing — the list is read out of the product itself. | |
| Screen required | Text | ||
| May be read | Yes or no | ||
| May be created | Yes or no | A create through the API goes through the same validation, numbering and posting rules as one typed on screen. | |
| May be changed | Yes or no | ||
| May be deleted | Yes or no | ||
| Columns | Choice | listed, all, all_but | listed — only what is named below, and nothing else is ever sent. all — every column. all_but — everything except what is named below. |
| Column names | Text | Comma separated. A misspelt name here is silent, so use the picker in API Studio where you can see what the screen actually has. | |
| Rows that may travel | Text | 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. | |
| Most rows per call | Number | ||
| Offer as an MCP tool | Yes or no | ||
| What to tell a model | Long text | Only where a model needs telling something a developer would not. Left blank, the description above is used. | |
| Status | Choice | draft, active, suspended, retired | Only an active exposure is reachable. A draft is a decision somebody is still writing. |
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.