System API
The system branch (/system/{tenant}) exposes the system.* namespace types — the platform's own configuration objects rather than the tenant's business data. It mirrors the data branch's read and query shape (list, get, aggregations, related, distinct, Excel, scripts) but is scoped to system types, and adds dedicated write endpoints for identities, credentials, and settings.
Known endpoints (from SystemDataController):
| Method | Path | Purpose |
|---|---|---|
GET | {typePluralName} | List system objects of a type. |
GET | {typePluralName}/{id} | Get a single system object. |
GET | {typePluralName}/aggregations | Aggregations over a system type. |
GET | {relatedTypePluralName}/{relatedId}/{typePluralName} | Related system list. |
GET | {relatedTypePluralName}/{relatedId}/{typePluralName}/aggregations | Related aggregations. |
POST | userProfiles | Create a user profile. |
PATCH | userProfiles/{id} | Update a user profile. |
POST | apiKeys | Create an API key. |
POST | userProfiles/{userProfileId}/apiKeys | Create an API key for a user profile. |
DELETE | apiKeys/{id} | Revoke an API key. |
POST | {typePluralName}/{id}/scripts/{scriptName} | Run a script on a system object. |
POST | systemSettings | Create a system setting. |
PATCH | systemSettings/{id} | Update a system setting. |
DELETE | systemSettings/{id} | Delete a system setting. |
POST | secretValues | Create a secret value. |
PATCH | secretValues/{id} | Update a secret value. |
DELETE | secretValues/{id} | Delete a secret value. |
GET | excel/{typePluralName} | Excel export of a system list. |
GET | excel/{relatedTypePluralName}/{relatedId}/{typePluralName} | Excel export of a related system list. |
The create endpoints (userProfiles, apiKeys, userProfiles/{userProfileId}/apiKeys, systemSettings, secretValues) return 201 Created with a Location header pointing at the new object's URI and no response body. The patch endpoints (userProfiles/{id}, systemSettings/{id}, secretValues/{id}) return 204 No Content with a Location header and no response body. In both cases, retrieve the object's current state with a follow-up GET against the Location URI.
This page is a stub. Document the key system types (user profiles, API keys, secret values, system settings), their JSON shapes, and how these tie into Authentication and external services / secrets.