admin-controller Endpoints

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 2020 Autumn

getForm JSON

Retrieves not enriched form by object type ID objecttype and optional query parameters situation and sots (secondary object types) for the active tenant.
/api-web/admin/forms/{objecttype}

POST
as of 2020 Autumn

postForm 

JSON

Updates not enriched form by object type ID objecttype and optional query parameters sots (secondary object types) for the active tenant, with the data passed in JSON format in the request body.
/api-web/admin/forms/{objecttype}

GET
as of 2020 Autumn

getIcon 

SVG

Retrieves a tenant-specific icon resource specified by path as SVG image.
/api-web/admin/resources/icon/{path}

POST
as of 2020 Autumn

postIcon

HTTP status code

Creates or updates the tenant-specific icon resource specified by path with the data passed as SVG image in a multipart request body.
/api-web/admin/resources/icon/{path}

GET
as of 2020 Autumn

getLocalizedTextResources 

JSON

Retrieves tenant-specific localized text resources for the Accept-Language formatted in ISO norm (e.g., de, en, es, fr, ...)
/api-web/admin/resources/text

POST
as of 2020 Autumn
postLocalizedTextResources HTTP status code

Updates the tenant-specific localized text resources for the active tenant and the specified locale formatted in ISO norm de, en, es, fr, ....
/api-web/admin/resources/text/{locale}

GET
as of 2020 Autumn

getSupportedLanguages 

JSON

Retrieves a list of all used languages for resources of the active tenant.
/api-web/admin/resources/text/languages