Platform › Published API
API Grants
Which software may reach which exposure, and with which verbs. Two partners can hold keys to this company and reach entirely different data; withdrawing one changes nothing for the other.
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Published API
- Screen: API Grants
Address in the console: /platform/api-grants
List · 12 columns · 7 fields on its form · 2 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 |
|---|---|---|
| Client | Code | client_code |
| Software | Text | client_name |
| Exposure | Code | exposure_code |
| Data | Text | exposure_name |
| Read | Yes or no | effective_read |
| Create | Yes or no | effective_create |
| Change | Yes or no | effective_update |
| Delete | Yes or no | effective_delete |
| Exposure | Status | exposure_status |
| Expires | Date | expires_at |
| Granted by | Text | granted_by_name |
| Granted | Date and time | granted_at |
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 |
|---|---|---|---|
| Client required | Choice | Looked up from existing records | |
| Exposure required | Choice | Looked up from existing records | |
| May read | Yes or no | ||
| May create | Yes or no | ||
| May change | Yes or no | ||
| May delete | Yes or no | ||
| Expires | Date | A grant for a one-off migration should have a date on it. A grant with no end is one nobody ever revisits. |
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.