admin-controller Endpoints

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
PurposeResponse FormatDescription
GET
as of 2021 Summer
getCatalogNamesJSON

Retrieves the catalog specified by its technical name of either global/app-specific or tenant-specific origin.
/api-web/api/admin/dms/catalogs

GET
as of 2021 Summer
getCatalog JSON

Retrieves the catalog specified by its technical name of either global/app-specific or tenant-specific origin.
/api-web/api/admin/dms/catalogs/{qname}

POST
as of 202
1 Summer
postCatalog JSON

Updatesthe tenant-specific catalog specified by its technical name with the data passed in the request body in JSON format.
/api-web/api/admin/dms/catalogs/{qname}

PATCH
as of 2021 Summer
updateCatalog JSON

Updates the existing tenant-specific catalog identified by its name qname, with the data passed in JSON format in the request body.
/api-web/api/admin/dms/catalogs/{qname}

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/api/admin/dms/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/api/admin/dms/forms/{objecttype}

GET
as of 2020 Winter

getConfig JSON

Retrieves the tenant-specific configuration file specified by name.
/api-web/api/admin/resources/config/{name}

POST
as of 2020 Winter
postConfig HTTP status code

Updates a tenant-specific configuration file specified by name with the data passed in JSON format in the request body.
/api-web/api/admin/resources/config/{name}

GET
as of 2020 Autumn

getIcon 

SVG

Retrieves a tenant-specific icon resource specified by path as SVG image.
/api-web/api/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/api/admin/resources/icon/{path}

GET
as of 2020 Autumn

getLocalizedTextResources 

JSON

Retrieves tenant-specific localized text resources for the Accept-Language specified in the request header formatted in ISO norm (e.g., de, en, es, fr, ...)
/api-web/api/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/api/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/api/admin/resources/text/languages