Admin Endpoints
These endpoints allow the administration of system properties for a tenant. They enable the tenant administrator to apply changes to the tenant-specific schema of available object types as well as to the rolesset carrying the permissions. Tenant is always the one the requesting administrative user belongs to. Note: to use this API, you must be a tenant administrator. This means that you must have specific authorizations.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
Permissions via Roles | |||
| GET as of 1.0 | Retrieve the tenants role set | XML | Retrieves the roleset of the tenant in its XML format. /api/admin/permissions |
| POST as of 1.0 | Update the tenants role set | JSON | Updates the tenants role set upon successful validation of the sent XML, or returns a list containing validation errors otherwise. /api/admin/permissions |
| POST as of 1.0 | Validate the tenants role set | JSON | Validates the tenants role set, as it is also done implicitly before updating a role set, but without updating it thereafter. /api/admin/permissions/validate |
Schema | |||
| GET as of 1.0 | Retrieve the tenants schema | XML / JSON | Retrieves the tenants schema in either XML or in JSON format. /api/admin/schema |
| POST as of 1.0 | Update the tenants schema | JSON | Updates the tenants schema upon successful validation of the sent XML, or returns a list containing validation errors otherwise. /api/admin/schema |
| POST as of 1.0 | Validate the tenants schema | JSON | Validates a tenants schema, as it is also done implicitly before updating a schema, but without updating it thereafter. /api/admin/schema/validate |
| Metrics | |||
| GET as of 2023 Spring | Retrieve the tenant metric | JSON | Retrieve the specified metric for the currently active tenant./api/admin/metrics/{metric} |
| DELETE as of 2023 Spring | Reset the tenant metric | HTTP status code | Reset the specified metric for the currently active tenant./api/admin/metrics/{metric} |