Versions Compared

Old Version 2

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 3

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Page Properties
hiddentrue
idPROGRESS

Product Version
Report Note
AssigneeInga

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.

    (error) LINK to the SWAGGER UI and back ...

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New 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.

Returns a result list configuration by type. (question) Inga - result list = hit list (question)
/userSaves a result list configuration for the user by type.
/userThis request retrieves the global settings with the section name.
/userSaves a global settings by a section.
/userThis request retrieves the general settings of the requested user.
/userSaves a general settings for the user.
/userSaves a settings for the user by a section. (question) Speichern der Konfigurationsdaten für den angemeldeten Benutzer pro Sektion im JSON-Format (question)
/userThis Request retrieves all users matching the search string.
/userThis request retrieves the user information of the current logged in user. (question) Das Lesen von Benutzernamen und E-Mail etc.  (question)
/user
HTTP Method
as of product version		PurposeResponse FormatDescription
GET
as of 2020 Autumn		getUserInfo - retrieves the user information by userIdJSONThis Request retrieves the user information of the requested user.
/user

Insert excerpt
GET /api-web/api/users/{userId}
GET /api-web/api/users/{userId}

/info

nopaneltrue

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

GET
as of 2020 Autumn		getResultListConfiguration - retrieves result list configurationJSON

Insert excerpt
GET /api-web/api/users/config/result/{type}
GET /api-web/api/users/config/result/{type}
nopaneltrue

/api-web/api/users/config/result/{type}

POST
as of 2020 Autumn		saveResultListConfiguration - saves a result list configuration for a userHTTP status code

Insert excerpt
POST /api-web/api/users/config/result/{type}
POST /api-web/api/users/config/result/{type}
nopaneltrue

/api-web/api/users/config/result/{type}

GET
as of 2020 Autumn		getGlobalSettings - retrieves the global settings by section nameJSON

Insert excerpt
GET /api-web/api/users/globalsettings/{section}
GET /api-web/api/users/globalsettings/{section}
nopaneltrue

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

POST
as of 2020 Autumn		saveGlobalSettings - saves global setting for a sectionHTTP status code

Insert excerpt
POST /api-web/api/users/globalsettings/{section}
POST /api-web/api/users/globalsettings/{section}
nopaneltrue

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

GET
as of 2020 Autumn		getGeneralSettings - retrieves the general settings of the userJSON

Insert excerpt
GET /api-web/api/users/settings
GET /api-web/api/users/settings
nopaneltrue

/api-web/api/users/settings

POST
as of 2020 Autumn		saveGeneralSettings - saves the general setting for the userHTTP status code

Insert excerpt
POST /api-web/api/users/settings
POST /api-web/api/users/settings
nopaneltrue

/api-web/api/users/settings

GET
as of 2020 Autumn		getSettings - retrieves the settings of requested userJSONThis request retrieves the settings of the requested user in user matching the section name. (question) Inga: verstehe ich nicht - Lesen der Konfigurationsdaten kann für den angemeldeten Benutzer und Sektion erfolgen (question)
/user

Insert excerpt
GET /api-web/api/users/settings/{section}
GET /api-web/api/users/settings/{section}
nopaneltrue

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

POST
as of 2020 Autumn		saveSettings - saves user setting by sectionHTTP status code/api-web/api/users/settings/{section}
GET
as of 2020 Autumn		getUsers - retrieves user matching the search stringJSON

Insert excerpt
GET /api-web/api/users/users
GET /api-web/api/users/users
nopaneltrue

/api-web/api/users/users

GET
as of 2020 Autumn		whoAmI - retrieves current user's infoJSON

Insert excerpt
GET /api-web/api/users/whoami
GET /api-web/api/users/whoami
nopaneltrue

/api-web/api/users/whoami