...
| Excerpt |
|---|
Endpoints of the Web-API gateway for user settings management, accessible for any authenticated user. |
>> >> API-WEB Service
The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the the USERSERVICE.
HTTP Method
as of product version | Purpose | Response Format | Description |
|---|
GET
as of 2020 Autumn,
deprecateted as of 2023 Spring | getUserInfo |
- retrieves the user information by userId | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/{userId} |
|---|
| GET /api-web/api/users/{userId} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/{userId} |
GET
as of 2020 Autumn | getResultListConfiguration |
- retrieves result list configuration | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/config/result/{type} |
|---|
| GET /api-web/api/users/config/result/{type} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/config/result/{type} |
POST
as of 2020 Autumn | saveResultListConfiguration |
- saves a result list configuration for a user | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/users/config/result/{type} |
|---|
| POST /api-web/api/users/config/result/{type} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/config/result/{type} |
GET
as of 2020 Autumn,
deprecateted as of 2021 Winter | getGlobalSettings |
- retrieves the global settings by section name | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/globalsettings/{section} |
|---|
| GET /api-web/api/users/globalsettings/{section} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/globalsettings/{section} |
POST
as of 2020 Autumn,
deprecateted as of 2021 Winter | saveGlobalSettings |
- saves global setting for a section | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/users/globalsettings/{section} |
|---|
| POST /api-web/api/users/globalsettings/{section} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/globalsettings/{section} |
GET
as of 2020 Autumn | getGeneralSettings |
- retrieves the general settings of the user | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/settings |
|---|
| GET /api-web/api/users/settings |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/settings |
POST
as of 2020 Autumn | saveGeneralSettings |
- saves the general setting for the user | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/users/settings |
|---|
| POST /api-web/api/users/settings |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/settings |
GET
as of 2020 Autumn | getSettings |
- retrieves the settings of requested user - saves user setting by section | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/users/settings/{section} |
|---|
| POST /api-web/api/users/settings/{section} |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/settings/{section} |
GET
as of 2020 Autumn,
deprecateted as of 2023 Spring | getUsers |
- retrieves user matching the search string | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/users |
|---|
| GET /api-web/api/users/users |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/users |
GET
as of 2020 Autumn,
|
whoAmI - retrieves current user's info| deprecateted as of 2023 Spring | whoAmI | JSON | | Insert excerpt |
|---|
| GET /api-web/api/users/whoami |
|---|
| GET /api-web/api/users/whoami |
|---|
| nopanel | true |
|---|
|
/api-web/api/users/whoami |