Admin Endpoints

Owned by Team Oktopus
Last updated: Mar 03, 2023 by Technische Redaktion

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		PurposeResponse FormatDescription

Permissions via Roles



GET
as of 1.0
Retrieve the tenants role setXMLRetrieves the roleset of the tenant in its XML format.
/api/admin/permissions
POST
as of 1.0
Update the tenants role setJSONUpdates 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 setJSONValidates 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 schemaXML / JSONRetrieves the tenants schema in either XML or in JSON format.
/api/admin/schema
POST
as of 1.0
Update the tenants schemaJSONUpdates 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 schemaJSONValidates 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 metricJSONRetrieve the specified metric for the currently active tenant.
/api/admin/metrics/{metric}
DELETE
as of 2023 Spring		Reset the tenant metricHTTP status codeReset the specified metric for the currently active tenant.
/api/admin/metrics/{metric}