Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

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

Add a new line to this table and fill it whenever you edit the page.

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Agnieszka02 JUNE 20212.4rLANG



Endpoints of the Web-API gateway for the management of tenant-specific configuration data, accessible for users with the YUUVIS_TENANT_ADMIN role.


>> API-WEB Service

The endpoints are used by the ARCHITECT Service that provides yuuvis® architect.

HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2021 Summer
getCatalogNamesJSON
GET
as of 2021 Summer
getCatalog JSON
POST
as of 202
1 Summer
postCatalog JSON
PATCH
as of 2021 Summer
updateCatalog JSON

GET
as of 2020 Autumn

getForm JSON
POST
as of 2020 Autumn

postForm 

JSON

GET
as of 2020 Winter

getConfig JSON
POST
as of 2020 Winter
postConfig HTTP status code
GET
as of 2020 Autumn

getIcon 

SVG
POST
as of 2020 Autumn

postIcon

HTTP status code
GET
as of 2020 Autumn

getLocalizedTextResources 

JSON
POST
as of 2020 Autumn
postLocalizedTextResources HTTP status code
GET
as of 2020 Autumn

getSupportedLanguages 

JSON