...
| Excerpt |
|---|
Endpoints of the Web-API gateway for the management of tenant-specific configuration data, accessible with the 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 |
...