Page Comparison

Page Properties

hidden	true
id	PROGRESS

Product Version
Report Note
Assignee	Inga

Resources & Remarks

16 Jan 2020 - page created (Inga)
ToDo - short term - the information of the endpoints should be available as a brief overview (similar to the core API overview endpoint tables). A link to the provided Swagger UI should point the system integrator as well as the administrator into that direction. Background - if you do not have the yuuvis® installed yet the Swagger UI won't be available (e.g. https://momentum23.enaioci.net/api-web/swagger-ui.html#/).
Located in https://help.optimal-systems.com/yuuvis_develop/pages/viewpage.action?pageId=40141818 all available controller should be described somehow - including the information from the Jira issues's description (https://jira.optimal-systems.de/browse/DOKU-761)
Note: for accessing the admin-controller special roles are needed for the Administrator. Similar behavior for the System Integrator - a special role needs to be assigned to be able to set up calls - check the rights for the other controller as well ...
For a quick try out without the need to install yuuvis® Momentum, consider our yuuvis® Ultimate SaaS (Software as a Service) offer. Keep in mind that you need to set up a (free) account.
LINK to the SWAGGER UI and back ...

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.

Excerpt
The higher-level API Endpoints of the Web-API Gateway on top of the core, as it is useful for client application developersgateway 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 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 userIdJSONThis Request retrieves the user information of the requested user.
/user

JSON

Insert excerpt

	GET /api-web/api/users/{userId}
	GET /api-web/api/users/{userId}
nopanel	true

/api-web/api/users/{userId}

/info


GET as of 2020 Autumn	getResultListConfiguration

- retrieves result list configuration/user

JSON

Returns a result list configuration by type.

Inga - result list = hit list

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 userSaves a result list configuration for the user by type.
/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 nameJSONThis request retrieves the global settings with the section name.
/user

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 sectionSaves a global settings by a section.
/user

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 userJSONThis request retrieves the general settings of the requested user.
/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 userSaves a general settings for the user.
/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/user

JSON

This request retrieves the settings of the requested user in user matching the section name.

Inga: verstehe ich nicht - Lesen der Konfigurationsdaten kann für den angemeldeten Benutzer und Sektion erfolgen

Insert excerpt

	GET /api-web/api/users/settings/{section}
	GET /api-web/api/users/settings/{section}
nopanel	true

/api-web/api/users/settings/{section}

POST
as of 2020 Autumn

saveSettings

- saves user setting by sectionSaves a settings for the user by a section.

Speichern der Konfigurationsdaten für den angemeldeten Benutzer pro Sektion im JSON-Format

/user

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 stringJSONThis Request retrieves all users matching the search string.
/user

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,
deprecateted as of 2023 Spring

whoAmI

- retrieves current user's infoJSONThis request retrieves the user information of the current logged in user.

Das Lesen von Benutzernamen und E-Mail etc.

/user

JSON

Insert excerpt

	GET /api-web/api/users/whoami
	GET /api-web/api/users/whoami
nopanel	true

/api-web/api/users/whoami

Versions Compared

Old Version 2

New Version Current

Key