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

yuuvis® Momentum 2020 Winter eLTS

System Endpoints

Permissions via Roles

Schema

Tracing

Related content