system-controller Endpoints

Endpoints of the Web-API gateway for the management of global configuration data, accessible with the role specified for /api-web/api/system/** 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_SYSTEM_INTEGRATOR role.

HTTP Method as of product version	Purpose	Response Format	Description
GET as of 2021 Summer	getCatalogNames	JSON	Retrieves the technical names of all catalogs grouped in lists depending on their global (system-wide) or app-specific storage location. /api-web/api/system/dms/catalogs
GET as of 2021 Summer	getCatalog	JSON	Retrieves the global or app-specific catalog specified by its name `qname` /api-web/api/system/dms/catalogs/{qname}
POST as of 2021 Summer	postCatalog	JSON	Updates the global or app-specific catalog identified by its name `qname` with the data passed in JSON format in the request body. /api-web/api/system/dms/catalogs/{qname}
PATCH as of 2021 Summer	updateCatalog	JSON	Updates the existing global or app-specific catalog identified by its name `qname`, with the data passed in JSON format in the request body. /api-web/api/system/dms/catalogs/{qname}
GET as of 2020 Autumn	getForm	JSON	Retrieves a global or app-specific not enriched form by object type ID `objecttype` and optional query parameters `situation` and `sots` (secondary object types). /api-web/api/system/dms/forms/{objecttype}
POST as of 2020 Autumn	postForm	HTTP status code	Updates a global or app-specific not enriched form identified by object type ID `objecttype` and optional query parameters `sots` (secondary object types) with the data passed in JSON format in the request body. /api-web/api/system/dms/forms/{objecttype}
GET as of 2020 Winter	getConfig	JSON	Retrieves the global configuration file specified by `name`. /api-web/api/system/resources/config/{name}
POST as of 2020 Winter	postConfig	HTTP status code	Updates the global configuration file specified by `name` with the data passed in JSON format in the request body. /api-web/api/system/resources/config/{name}
GET as of 2020 Autumn	getIcon	SVG	Retrieves a global, app-specific, or tenant-specific icon resource specified by `path` as SVG image. /api-web/api/system/resources/icon/{path}
POST as of 2020 Autumn	postIcon	HTTP status code	Creates or updates the global or app-specific icon resource specified by `path` with the data passed as SVG image in a multipart request body. /api-web/api/system/resources/icon/{path}
GET as of 2020 Autumn	getLocalizedTextResources	JSON	This request retrieves global localized text resources for the `Accept-Language` specified in the request header. /api-web/api/system/resources/text
POST as of 2020 Autumn	postLocalizedTextResources	HTTP status code	Updates the global localized text resources for the specified `locale`. /api-web/api/system/resources/text/{locale}
GET as of 2020 Autumn	getSupportedLanguages	JSON	Retrieves a list of all supported languages for global resources. /api-web/api/system/resources/text/languages