Page Properties | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
Resources & Remarks Modification History
|
...
The endpoints for the management of app-specific resource files are provided by the API gateway and call the SYSTEM Service internally internally.
App names are case-insensitive. Furthermore, the system stores uppercase letters in app names in a lowercase form. For example, if you post an app schema for the app name myNewApp
(via POST /system/apps/myNewApp/schema
), this new app appears with the name mynewapp
in the results of endpoints like GET /api/dms/apps
or GET /api/system/apps
.
Additionally, app names have to match the regular expression ([a...zA...Z][a...zA...Z0...9]*-)?([a...zA...Z][a...zA...Z0...9]* in order to be consistent with the schema validation of app-specific prefixes.
...
App-specific schemata are managed via the following endpoints:
- GET /api/system/apps/{app}/schema
- POST /api/system/apps/{app}/schema
- POST / api/system/apps/{app}/schema/validate
In the multi-tenant landscape of yuuvis® Momentum, any object types or properties that need to be available for multiple or all tenants, need to be introduced to the system schema. To prevent cluttering the system schema, avoid dependencies and allow for duplicate names, the system schema can be structured into applications, which provide a namespace for properties and object types pertaining to a particular use case.
>> >> Schema - Defining Object Types
Role Sets for Apps
App-specific role sets are managed via the following endpoints:
- GET /api/system/apps/{app}/permissions
- POST /api/system/apps/{app}/permissions
- POST /api/system/apps/{app}/permissions/validate
The permissions to access objects or to perform certain actions are assigned to specific roles that are listed in the role set. yuuvis® Momentum has the ability to further structure the global role set into applications.
>> >> Access Authorization and Permissions
App-specific System Hooks
As of 2022 Summer, it is possible to configure app-specific system hooks in separate resource files.
>> >> systemHookConfiguration.json
...
- GET /api/system/apps/{app}/systemhooks
- POST /api/system/apps/{app}/systemhooks
- POST /api/system/apps/{app}/systemhooks/validate
App Sets for Availability Management
As of version 2021 Summer, the availability of an app for a specified tenant is managed in an app set via the following endpoints:
- GET /api/system/tenants/{tenant}/apps
- POST /api/system/tenants/{tenant}/apps
- POST /api/system/tenants/{tenant}/apps/validate
An app does not necessarily need its own resources within the core system. The core system can be used to only mark tenants to have a specific app. A new app can be introduced to the system by simply enabling if for a tenant. It is not necessary to create an initial resource (schema, role set or system hook configuration) for the app before you enable it for a tenant.
...