Endpoints of the Web-API gateway for user settings management, accessible for any authenticated user.
The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the USERSERVICE.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
| GET as of 2020 Autumn | getUserInfo - retrieves the user information by userId | JSON | Retrieves user-specific data for the user specified by |
| GET as of 2020 Autumn | getResultListConfiguration - retrieves result list configuration | JSON | Returns a result list configuration by type. |
| POST as of 2020 Autumn | saveResultListConfiguration - saves a result list configuration for a user | HTTP status code | Saves a result list configuration for the user by type. |
| GET as of 2020 Autumn | getGlobalSettings - retrieves the global settings by section name | JSON | This request retrieves the global settings with the section name. |
| POST as of 2020 Autumn | saveGlobalSettings - saves global setting for a section | HTTP status code | Saves a global settings by a section. |
| GET as of 2020 Autumn | getGeneralSettings - retrieves the general settings of the user | JSON | This request retrieves the general settings of the requested user. |
| POST as of 2020 Autumn | saveGeneralSettings - saves the general setting for the user | HTTP status code | Saves a general settings for the user. |
| GET as of 2020 Autumn | getSettings - retrieves the settings of requested user | JSON | This request retrieves the settings of the requested user in user matching the section name. |
| POST as of 2020 Autumn | saveSettings - saves user setting by section | HTTP status code | /api-web/api/users/settings/{section} |
| GET as of 2020 Autumn | getUsers - retrieves user matching the search string | JSON | Retrieves a list of all users. The result list can be filtered by applying conditions that have to be matched. |
| GET as of 2020 Autumn | whoAmI - retrieves current user's info | JSON | This request retrieves the user information of the current logged in user. |