...
| Page Properties |
|---|
|
| 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. | | Agnieszka | 02 JUNE 2021 | 2.4 | rLANG | | Antje | 08 FEB 2022 | 2022 Spring | required role is configurable |
|
| Excerpt |
|---|
Endpoints of the Web-API gateway for the management of tenant-specific configuration data, accessible for users with the YUUVIS_TENANT_ADMIN role. |
...
role specified for /api-web/api/admin/** endpoints in the authentication-prod.yml configuration file. |
>> API-WEB Service
The endpoints are used by the ARCHITECT Service that provides yuuvis® architect. If you want to use this service, do not change the default access condition that is matched with the YUUVIS_TENANT_ADMIN role.
HTTP Method
as of product version | Purpose | Response Format | Description |
|---|
GET
as of 2021 Summer | getCatalogNames | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/dms/catalogs/{qname} |
|---|
| GET /api-web/api/admin/dms/catalogs/{qname} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/catalogs |
GET
as of 2021 Summer | getCatalog | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/dms/catalogs/{qname} |
|---|
| GET /api-web/api/admin/dms/catalogs/{qname} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/catalogs/{qname} |
POST
as of 2021 Summer | postCatalog | JSON | | Insert excerpt |
|---|
| POST /api-web/api/admin/dms/catalogs/{qname} |
|---|
| POST /api-web/api/admin/dms/catalogs/{qname} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/catalogs/{qname} |
PATCH
as of 2021 Summer | updateCatalog | JSON | | Insert excerpt |
|---|
| PATCH /api-web/api/admin/dms/catalogs/{qname} |
|---|
| PATCH /api-web/api/admin/dms/catalogs/{qname} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/catalogs/{qname} |
GET
as of 2020 Autumn | getForm | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/dms/forms/{objecttype} |
|---|
| GET /api-web/api/admin/dms/forms/{objecttype} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/forms/{objecttype} |
POST
as of 2020 Autumn
| postForm | JSON | | Insert excerpt |
|---|
| POST /api-web/api/admin/dms/forms/{objecttype} |
|---|
| POST /api-web/api/admin/dms/forms/{objecttype} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/dms/forms/{objecttype} |
GET
as of 2020 Winter | getConfig | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/resources/config/{name} |
|---|
| GET /api-web/api/admin/resources/config/{name} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/config/{name} |
POST
as of 2020 Winter
| postConfig | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/admin/resources/config/{name} |
|---|
| POST /api-web/api/admin/resources/config/{name} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/config/{name} |
GET
as of 2020 Autumn | getIcon | SVG | | Insert excerpt |
|---|
| GET /api-web/api/admin/resources/icon/{path} |
|---|
| GET /api-web/api/admin/resources/icon/{path} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/icon/{path} |
POST
as of 2020 Autumn | postIcon | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/admin/resources/icon/{path} |
|---|
| POST /api-web/api/admin/resources/icon/{path} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/icon/{path} |
GET
as of 2020 Autumn | getLocalizedTextResources | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/resources/text |
|---|
| GET /api-web/api/admin/resources/text |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/text |
POST
as of 2020 Autumn | postLocalizedTextResources | HTTP status code | | Insert excerpt |
|---|
| POST /api-web/api/admin/resources/text/{locale} |
|---|
| POST /api-web/api/admin/resources/text/{locale} |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/text/{locale} |
GET
as of 2020 Autumn | getSupportedLanguages | JSON | | Insert excerpt |
|---|
| GET /api-web/api/admin/resources/text/languages |
|---|
| GET /api-web/api/admin/resources/text/languages |
|---|
| nopanel | true |
|---|
|
/api-web/api/admin/resources/text/languages |
...