System Endpoints
- Team Oktopus
- Technische Redaktion
These endpoints allow the administration of the yuuvis® Momentum system. Global schemas and role sets are merged into each tenant's schema and role set, making the contained object types and roles available in each of them. Note: To use this API, you must be a system administrator. This means that you must have specific authorizations.
| HTTP Method as of product version | Purpose | Response | Description |
|---|---|---|---|
Permissions via Roles | |||
| GET as of 1.0 | Retrieve the global role set | XML / JSON | Retrieves the global role set in its XML format. /api/system/permissions |
| POST as of 1.0 | Update the global role set | JSON | Updates the global role set upon successful validation of the sent XML, or returns a list containing validation errors. /api/system/permissions |
| POST as of 1.0 | Validate the global role set | JSON | Validates the global role set, as it is also done implicitly before updating a role set, but without updating it thereafter. /api/system/permissions/validate |
| GET as of 2020 Winter | Retrieve a global application role set | XML / JSON | Retrieves the global role set in its XML format specific to the application specified in the URL parameter. /api/system/apps/{app}/permissions |
| POST as of 2020 Winter | Update a global application role set | JSON | Updates the global role set specific to the application specified in the URL parameter upon successful validation of the sent XML, or returns a list containing validation errors. /api/system/apps/{app}/permissions |
| POST as of 2020 Winter | Validate a global application role set | JSON | Validates the global role set specific to the application specified in the URL parameter, as it is also done implicitly before updating a role set, but without updating it thereafter. /api/system/apps/{app}/permissions/validate |
| GET as of 2022 Autumn | Retrieve a tenant role set | XML / JSON | Retrieves the tenant-specific role set for the |
| POST as of 2022 Autumn | Update a tenant role set | JSON | Updates the tenant-specific role set for the |
| POST as of 2022 Autumn | Validate a tenant role set | JSON | Validates the tenant-specific role set for the |
Schema | |||
| GET as of 1.0 | Retrieve the global schema | XML / JSON | Retrieves the global schema either in XML or JSON format. /api/system/schema |
| POST as of 1.0 | Update the global schema | JSON | Updates the global schema upon successful validation of the sent XML, or returns a list containing validation errors. /api/system/schema |
| POST as of 1.0 | Validate the global schema | JSON | Validates the global schema, as it is also done implicitly before updating a schema, but without updating it thereafter. /api/system/schema/validate |
| GET as of 2021 Autumn | Retrieve the schema of the specified tenant | XML / JSON | Retrieves the tenant schema that is stored for the tenant matching the |
| POST as of 2021 Autumn | Update the schema of the specified tenant | JSON | Updates the tenant schema stored for the tenant specified by the |
| POST as of 2021 Autumn | Validate the schema of the specified tenant | JSON | Validate the XML file passed in the request body for the usability as tenant schema for the tenant specified by the |
| GET as of 2019 Winter | Retrieve the schema of the specified application | XML / JSON | Retrieves the schema of the application specified by the path parameter /api/system/apps/{app}/schema |
| POST as of 2019 Winter | Update the schema of the specified application | JSON | Updates the schema of the specified application upon successful validation of the sent XML, or returns a list containing validation errors. /api/system/apps/{app}/schema |
| POST as of 2019 Winter | Validate the schema of the specified application | JSON | Validates the schema of the specified application, as it is also done implicitly before updating a schema, but without updating it thereafter. /api/system/apps/{app}/schema/validate |
System Hook Configuration | |||
| GET as of 2022 Summer | Retrieve the global system hook configuration | JSON | Retrieves the global system hook configuration. |
| POST as of 2022 Summer | Update the global system hook configuration | HTTP status code | Updates the global system hook configuration. |
| POST as of 2022 Summer | Validate the global system hook configuration | HTTP status code | Validates the global system hook configuration. |
| GET as of 2022 Summer | Retrieve the system hook configuration of the specified application | JSON | Retrieves the app-specific system hook configuration for the |
| POST as of 2022 Summer | Update the system hook configuration of the specified application | HTTP status code | Updates the app-specific system hook configuration for the |
| POST as of 2022 Summer | Validate the system hook configuration of the specified application | HTTP status code | Validates the app-specific system hook configuration for the |
App Information and Availability Management | |||
| GET as of 2021 Summer | Retrieve all applications | JSON | Retrieves all existing applications in the system. |
| GET as of 2021 Summer | Retrieve tenant app set. | JSON | Retrieves the app set for the specified tenant. /api/system/tenants/{tenant}/apps |
| POST as of 2021 Summer | Update tenant app set | JSON | Updates the app set for the specified tenant. /api/system/tenants/{tenant}/apps |
| POST as of 2021 Summer | Validate tenant app set | JSON | Validates the app set for the specified tenant. |
Tracing | |||
| GET as of 2.2 | Retrieve active DMS calls | JSON | Retrieves active DMS calls (/api/dms) in the system to determine what state they are in. This also gives an idea about the current system load. Finished and erroneous calls are not part of the result. |
| GET as of 2.2 | Retrieve active DMS call for the specified traceid | JSON | Retrieves the related active DMS call (/api/dms) in the system for a specified traceid to determine what state it is in. |
Metrics | |||
| GET as of 2023 Spring | Retrieve metric for all tenants | JSON | Retrieve the specified metric for all tenants./api/system/metrics/{metric} |
| DELETE as of 2023 Spring | Reset metric for all tenants | HTTP status code | Reset the specified |
| GET as of 2023 Spring | Retrieve metric for the specified tenant | JSON | Retrieve the specified metric for the specified tenant./api/system/tenants/{tenant}/metrics/{metric} |
| DELETE as of 2023 Spring | Reset metric for the specified tenant | HTTP status code | Reset the specified |