System Endpoints

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
PurposeResponseDescription

Permissions via Roles

GET
as of 1.0
Retrieve the global role setXML / JSONRetrieves the global role set in its XML format.
/api/system/permissions
POST
as of 1.0
Update the global role set
JSONUpdates 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 setJSONValidates 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
Retrieveglobal application role setXML / JSONRetrieves 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
JSONUpdates 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 setJSONValidates 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 setXML / JSON

Retrieves the tenant-specific role set for the tenant specified in the request URL.
/api/system/tenants/{tenant}/permissions

POST
as of 2022 Autumn
Update a tenant role set
JSON

Updates the tenant-specific role set for the tenant specified in the request URL.
/api/system/tenants/{tenant}/permissions

POST
as of 2022 Autumn
Validate a tenant role setJSON

Validates the tenant-specific role set for the tenant specified in the request URL.
/api/system/tenants/{tenant}/permissions/validate


Schema

GET
as of 1.0
Retrieve the global schemaXML / JSONRetrieves the global schema either in XML or JSON format.
/api/system/schema
POST
as of 1.0
Update the global schemaJSONUpdates 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
JSONValidates 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 tenantXML / JSON

Retrieves the tenant schema that is stored for the tenant matching the {tenant} path parameter.
/api/system/tenants/{tenant}/schema

POST
as of 2021 Autumn
Update the schema of the specified tenant
JSON

Updates the tenant schema stored for the tenant specified by the {tenant} path parameter.
/api/system/tenants/{tenant}/schema

POST
as of 2021 Autumn
Validate the schema of the specified tenantJSON

Validate the XML file passed in the request body for the usability as tenant schema for the tenant specified by the {tenant} path parameter.
/api/system/tenants/{tenant}/schema/validate

GET
as of 2019 Winter
Retrieve the schema of the specified applicationXML / JSONRetrieves 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
JSONUpdates 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 applicationJSONValidates 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 configurationJSON

Retrieves the global system hook configuration.
/api/system/systemhooks

POST
as of 2022 Summer
Update the global system hook configurationHTTP status code

Updates the global system hook configuration.
/api/system/systemhooks

POST
as of 2022 Summer
Validate the global system hook configurationHTTP status code

Validates the global system hook configuration.
/api/system/systemhooks/validate

GET
as of 2022 Summer
Retrieve the system hook configuration of the specified applicationJSON

Retrieves the app-specific system hook configuration for the app specified in the request URL.
/api/system/apps/{app}/systemhooks

POST
as of 2022 Summer
Update the system hook configuration of the specified applicationHTTP status code

Updates the app-specific system hook configuration for the app specified in the request URL.
/api/system/apps/{app}/systemhooks

POST
as of 2022 Summer
Validate the system hook configuration of the specified applicationHTTP status code

Validates the app-specific system hook configuration for the app specified in the request URL.
/api/system/apps/{app}/systemhooks/validate


App Information and Availability Management

GET
as of 2021 Summer
Retrieve all applicationsJSON

Retrieves all existing applications in the system.
/api/system/apps

GET
as of 2021 Summer
Retrieve tenant app set.JSONRetrieves the app set for the specified tenant.
/api/system/tenants/{tenant}/apps
POST
as of 2021 Summer

Update tenant app set

JSONUpdates the app set for the specified tenant.
/api/system/tenants/{tenant}/apps
POST
as of 2021 Summer
Validate tenant app setJSON

Validates the app set for the specified tenant.
/api/system/tenants/{tenant}/apps/validate


Tracing

GET
as of 2.2
Retrieve active DMS callsJSON

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.
/api/system/calls

GET
as of 2.2
Retrieve active DMS call for the specified traceidJSON

Retrieves the related active DMS call (/api/dms) in the system for a specified traceid to determine what state it is in.
/api/system/calls/{traceid}


Metrics



GET
as of 2023 Spring
Retrieve metric for all tenantsJSONRetrieve the specified metric for all tenants.
/api/system/metrics/{metric}
DELETE
as of 2023 Spring
Reset metric for all tenantsHTTP status code

Reset the specified metric for all tenants.
/api/system/metrics/{metric}

GET
as of 2023 Spring
Retrieve metric for the specified tenantJSONRetrieve the specified metric for the specified tenant.
/api/system/tenants/{tenant}/metrics/{metric}
DELETE
as of 2023 Spring
Reset metric for the specified tenantHTTP status code

Reset the specified metric for the specified tenant.
/api/system/tenants/{tenant}/metrics/{metric}