Versions Compared

Old Version 1

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

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
AssigneeIngaAntje

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.02 MAR 20232023 Springcreated



    Excerpt

    Endpoints of the Web-API gateway for user settings management, accessible for any authenticated userinformation and role retrieval.


    >> API-WEB Service

    The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the USERSERVICE.

    new GET /api-web/api/idm/globalsettings/{section}/users/globalsettings{section}new POST /api-web/api/globalsettings/{section}/api-web/api//globalsettings/{section}saveGeneralSettingsnew POST /api-web/api/idm/settings/api-web/api/users/settingswhoami

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

    /api-web/api/users/whoamiidm/search

    HTTP Method
    as of product version    		PurposeResponse FormatDescription
    GET
    as of 2020 Autumn2023 Spring    		getUserInfoJSON

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

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

    GET
    as of 2020 Autumn2023 Spring    		getResultListConfigurationgetUsersJSON

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

    		POST
    as of 2020 Autumn    		saveResultListConfigurationHTTP status code

    new POST /api-web/api/idm/config/result/{type}new POST /users
    GET /api-web/api/idm/config/result/{type}
    nopaneltrue
    /api-web
    /
    api/
    users
    /config/result/{type}

    GET
    as of 2020 Autumn,
    deprecateted as of 2021 Winter

    		getGlobalSettingsJSON
    Insert excerpt

    		new GET /api-web/api/idm/globalsettings/{section}

    nopaneltrue

    /api-web/api

    /

    		POST
    as of 2020 Autumn,
    deprecateted as of 2021 Winter    		saveGlobalSettingsHTTP status code
    Insert excerpt

    idm/

    		new POST /api-web/api/idm/globalsettings/{section}
    nopaneltrue

    users

    GET
    as of 2020 Autumn2023 Spring    		getGeneralSettingswhoAmIJSON

    Insert excerpt
    new GET /api-web/api/idm/settingswhoaminew
    GET /api-web/api/idm/settingswhoami
    nopaneltrue
    /api-web/api/users/settings

    		POST
    as of 2020 Autumn

    		HTTP status code


    Insert excerpt
    new POST /api-web/api/idm/settings
    nopaneltrue
    GET
    as of 2020 Autumn2023 Spring    		getSettingsgetRolesJSON

    Insert excerpt
    new GET /api-web/api/idm/settings/{section}rolesnew
    GET /api-web/api/idm/settings/{section}roles
    nopaneltrue

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

    		POST
    as of 2020 Autumn    		saveSettingsHTTP status code

    Insert excerpt
    new POST /api-web/api/idm/settings/{section}new POST /api-web/api/idm/settings/{section}
    nopaneltrue
    GET
    as of 2020 Autumn2023 Spring    		getUserssearchUsersAndRolesJSON

    Insert excerpt
    GET /api-web/api/idm/userssearch
    GET /api-web/api/idm/userssearch
    nopaneltrue

    /api-web/api/users/users

    		GET
    as of 2020 Autumn    		whoAmIJSON

    Insert excerpt
    GET /api-web/api/idm/whoamiGET /api-web/api/idm/whoami
    nopaneltrue