The higher-level API of the Web-API Gateway on top of the core, as it is useful for client application developers.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
admin-controller (manage tenant resources) | |||
| GET as of 2021 Summer | getCatalogNames - returns names of the all global and tenant catalogs. | JSON | /api/admin/dms/catalogs |
| GET as of 2021 Summer | getCatalog - Returns a catalog by a name. Returns null if there is no catalog with this name. | JSON | /api/admin/dms/catalogs/{qname} |
| POST as of 2021 Summer | postCatalog - Safes a catalog. | HTTP status code | /api/admin/dms/catalogs/{qname} |
| PATCH as of 2021 Summer | updateCatalog - Updates a catalog. | JSON | /api/admin/dms/catalogs/{qname} |
GET | getForm - retrieves form by object type  | JSON | Returns not enriched form by type, situation and for specified tenant. Returns null, if there is no designed form model for the given type and situation. |
| POST as of 2020 Autumn | postForm - saves not enriched form | JSON | Saves not enriched form. |
GET | getConfig - The request returns a admin configuration | JSON | /api/admin/resources/config/{name} |
| POST as of 2020 Winter | postConfig - This Request updates a tenant client configuration | HTTP status code | /api/admin/resources/config/{name} |
| GET as of 2020 Autumn | getIcon - retrieves icon resource | SVG | This request returns an icon resource as SVG image. |
| POST as of 2020 Autumn | postIcon - updates the icon resource | SVG | This Request update icon for the specified path./admin/resources/icon/{path} |
| GET as of 2020 Autumn | getLocalizedTextResources - retrieves text resources | JSON | This request retrieves localized text resources for the Accept-Language./admin/resources/text |
| POST as of 2020 Autumn | postLocalizedTextResources - updates text resources | JSON | This Request update localized text resources for the specified tenant and locale./admin/resources/text/{locale} |
| GET as of 2020 Autumn | getSupportedLanguages - retrieves all languages | JSON | This request returns all supported languages for |
bpm-controller (manage process instances) | |||
| GET as of 2020 Autumn | getProcessInstances - retrieves process instances | JSON | List of process instances/bpm/process/instances |
| POST as of 2020 Autumn | createProcessInstance - starts a process instance | JSON | Start a process instance/bpm/process/instances |
| DELETE as of 2020 Autumn | delete dms object - deletes dms object | delete dms object/bpm/process/instances/{processInstanceId} | |
| POST as of 2020 Autumn | getTasks - retrieves a list of process instances | List of process instances/bpm/tasks | |
| GET as of 2020 Autumn | taskActions - Tasks actions | Tasks actions | |
dms-controller (manage DMS objects) | |||
| GET as of 2020 Autumn | getMetadata - retrieves dms object's metadata | JSON | Returns a dms object metadata./dms/{id} |
| DELETE as of 2020 Autumn | delete dms object - deletes dms object | delete dms object/dms/{id} | |
| GET as of 2020 Autumn | getContent - returns dms object's content | Returns a dms object content./dms/{id}/content | |
| GET as of 2020 Autumn | getAllVersions - retrieves a dms object with all versions | Returns a dms object dms object with all versions./dms/{id}/versions | |
| GET as of 2020 Autumn | getMetadata - retrieves dms object's metadata of a specific version | JSON | Returns a dms object metadata for specific version./dms/{id}/versions/{version} |
| POST as of 2020 Autumn | create - creates a dms object | JSON | create dms object/dms/create |
| GET as of 2020 Autumn | getForm - retrieves form by object type | JSON | Returns a form by type and a situation. A default form will be created, if there is no designed form model for the given type and situation./dms/form/{objecttype} |
| POST as of 2020 Autumn | search - requests objects | JSON | requests objects/dms/search |
| PATCH as of 2020 Autumn | update - updates dms object | JSON | update dms object/dms/update/{id} |
| POST as of 2020 Autumn | update content of dms object | update content of dms object | |
resource-controller (retrieve resources) | |||
| GET as of 2020 Autumn | getIcon - retrieves icon resource | This request returns an icon resource as SVG image. | |
| GET as of 2020 Autumn | getLocalizedTextResources - retrieves text resources | This request retrieves localized text resources for the Accept-Language./resources/text | |
system-controller (manage global resources) | |||
GET | getForm - retrieves form by object type | JSON | Returns not enriched form by a global type, situation and for specified tenant. Returns null, if there is no designed form model for the given type and situation. |
| POST as of 2020 Autumn | postForm - saves not enriched form | JSON | Saves not enriched form. |
| GET as of 2020 Autumn | getIcon - retrieves icon resource | SVG | This request returns an icon resource as SVG image. |
| POST as of 2020 Autumn | postIcon - updates the icon resource | SVG | This Request update icon for the specified path./system/resources/icon/{path} |
| GET as of 2020 Autumn | getLocalizedTextResources - retrieves text resources | JSON | This request retrieves localized text resources for the Accept-Language./system/resources/text |
| POST as of 2020 Autumn | postLocalizedTextResources - updates text resources | JSON | This Request update localized text resources for the specified tenant and locale./system/resources/text/{locale} |
| GET as of 2020 Autumn | getSupportedLanguages - retrieves all languages | JSON | This request returns all supported languages for |
user-controller - manger user specific information | |||
| GET as of 2020 Autumn | getUserInfo - retrieves the user information by userId | JSON | This Request retrieves the user information of the requested user./user/{userId}/info |
| GET as of 2020 Autumn | getResultListConfiguration - retrieves result list configuration | JSON | Returns a result list configuration by type.  Inga - result list = hit list /user/config/result/{type} |
| POST as of 2020 Autumn | saveResultListConfiguration - saves a result list configuration for a user | Saves a result list configuration for the user by type./user/config/result/{type} | |
| GET as of 2020 Autumn | getGlobalSettings - retrieves the global settings by section name | JSON | This request retrieves the global settings with the section name./user/globalsettings/{section} |
| POST as of 2020 Autumn | saveGlobalSettings - saves global setting for a section | Saves a global settings by a section./user/globalsettings/{section} | |
| GET as of 2020 Autumn | getGeneralSettings - retrieves the general settings of the user | JSON | This request retrieves the general settings of the requested user./user/settings |
| POST as of 2020 Autumn | saveGeneralSettings - saves the general setting for the user | Saves a general settings for the user./user/settings | |
| GET as of 2020 Autumn | getSettings - retrieves the settings of requested user | JSON | This request retrieves the settings of the requested user in user matching the section name. Inga: verstehe ich nicht - Lesen der Konfigurationsdaten kann für den angemeldeten Benutzer und Sektion erfolgen /user/settings/{section} |
| POST as of 2020 Autumn | saveSettings - saves user setting by section | Saves a settings for the user by a section. Speichern der Konfigurationsdaten für den angemeldeten Benutzer pro Sektion im JSON-Format /user/settings/{section} | |
| GET as of 2020 Autumn | getUsers - retrieves user matching the search string | JSON | This Request retrieves all users matching the search string./user/users |
| GET as of 2020 Autumn | whoAmI - retrieves current user's info | JSON | This request retrieves the user information of the current logged in user. Das Lesen von Benutzernamen und E-Mail etc. /user/whoami |