Page Comparison

Page Properties

hidden	true
id	PROGRESS

Product Version
Report Note
Assignee	Inga

Resources & Remarks

16 Jan 2020 - page created (Inga)
ToDo - short term - the information of the endpoints should be available as a brief overview (similar to the core API overview endpoint tables). A link to the provided Swagger UI should point the system integrator as well as the administrator into that direction. Background - if you do not have the yuuvis® installed yet the Swagger UI won't be available (e.g. https://momentum23.enaioci.net/api-web/swagger-ui.html#/).
Located in https://help.optimal-systems.com/yuuvis_develop/pages/viewpage.action?pageId=40141818 all available controller should be described somehow - including the information from the Jira issues's description (https://jira.optimal-systems.de/browse/DOKU-761)
Note: for accessing the admin-controller special roles are needed for the Administrator. Similar behavior for the System Integrator - a special role needs to be assigned to be able to set up calls - check the rights for the other controller as well ...
For a quick try out without the need to install yuuvis® Momentum, consider our yuuvis® Ultimate SaaS (Software as a Service) offer. Keep in mind that you need to set up a (free) account.
LINK to the SWAGGER UI and back ...

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.

Excerpt
The higher-level API Endpoints of the Web-API Gateway on top of the core, as it is useful for client application developersgateway for user settings management, accessible for any authenticated user.

>> API-WEB Service

The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the USERSERVICE.

HTTP Method as of product version	Purpose	Response Format	Description

admin-controller (manage tenant resources)

GET
as of 

2021 SummergetCatalogNames - returns names of the all global and tenant catalogs.JSON/api/admin/dms/catalogsGET
as of 2021 SummergetCatalog - 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 SummerpostCatalog - Safes a catalog.HTTP status code/api/admin/dms/catalogs/{qname}PATCH
as of 2021 SummerupdateCatalog - Updates a catalog.JSON/api/admin/dms/catalogs/{qnamePOST
as of 2020 Autumn

postForm - saves not enriched form

JSON

Saves not enriched form.
/admin/form/{objecttype}

GET
as of 2020 Winter

getConfig - The request returns a admin configuration

JSON/api/admin/resources/config/{name

2020 Autumn,
deprecateted as of 2023 Spring

getUserInfo

JSON

Insert excerpt

	GET /api-web/api/users/{userId}
	GET /api-web/api/users/{userId}
nopanel	true

/api-web/api/users/{userId}

GET
as of 2020 Autumn

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.
/admin/form/{objecttype}

getResultListConfiguration

JSON

Insert excerpt

	GET /api-web/api/users/config/result/{type}
	GET /api-web/api/users/config/result/{type}
nopanel	true

/api-web/api/users/config/result/{type}

POST
as of 2020

Winter
postConfig - This Request updates a tenant client configuration

Autumn

saveResultListConfiguration

HTTP status code

Insert excerpt

	POST /api-web/

admin

api/

resources

users/config/result/{

nameThis Request update icon for the specified path.
/admin/resources/icon/{path

type}

GET
as of 2020 Autumn

getIcon - retrieves icon resource

SVG

This request returns an icon resource as SVG image.
/admin/icon/{path}

POST
as of 2020 Autumn

postIcon - updates the icon resource

SVG

POST /api-web/api/users/config/result/{type}
nopanel	true

/api-web/api/users/config/result/{type}

GET
as of 2020 Autumn

getLocalizedTextResources - retrieves text resourcesList of process instances
/bpm/process/instances

,
deprecateted as of 2021 Winter

getGlobalSettings

JSON

This request retrieves localized text resources for the Accept-Language.
/admin/resources/textPOST
as of 2020 AutumnpostLocalizedTextResources - updates text resourcesJSONThis 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 tenant resources.
/admin/resources/text/languages

bpm-controller (manage process instances)

GET
as of 2020 AutumngetProcessInstances - retrieves process instancesJSON

Insert excerpt

	GET /api-web/api/users/globalsettings/{section}
	GET /api-web/api/users/globalsettings/{section}
nopanel	true

/api-web/api/users/globalsettings/{section}

POST
as of 2020 Autumn

createProcessInstance - starts a process instanceJSONStart a process instance
/bpm/process/instancesDELETE
as of 2020 Autumndelete dms object - deletes dms objectdelete dms object
/bpm/process/instances/{processInstanceId}POST
as of 2020 AutumngetTasks - retrieves a list of process instancesList of process instances
/bpm/tasksGET
as of 2020 AutumntaskActions - Tasks actions

Tasks actions
/bpm/tasks/{taskId}

dms-controller (manage DMS objects)

GET
as of 2020 AutumngetMetadata - retrieves dms object's metadataJSONReturns a dms object metadata.
/dms/{id}DELETE
as of 2020 Autumndelete dms object - deletes dms objectdelete dms object
/dms/{id

,
deprecateted as of 2021 Winter

saveGlobalSettings

HTTP status code

Insert excerpt

	POST /api-web/api/users/globalsettings/{section}
	POST /api-web/api/users/globalsettings/{section}
nopanel	true

/api-web/api/users/globalsettings/{section}

GET
as of 2020 Autumn

getContent - returns dms object's contentReturns a dms object content.
/dms/{id}/contentGET
as of 2020 AutumngetAllVersions - retrieves a dms object with all versionsReturns a dms object dms object with all versions.
/dms/{id}/versionsGET
as of 2020 AutumngetMetadata - retrieves dms object's metadata of a specific versionJSONReturns a dms object metadata for specific version.
/dms/{id}/versions/{version}POST
as of 2020 Autumncreate - creates a dms objectJSONcreate dms object
/dms/createGET
as of 2020 AutumngetForm - retrieves form by object typeJSONReturns 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}

getGeneralSettings

JSON

Insert excerpt

	GET /api-web/api/users/settings
	GET /api-web/api/users/settings
nopanel	true

/api-web/api/users/settings

POST
as of 2020 Autumn

search - requests objectsJSONrequests objects
/dms/searchPATCH
as of 2020 Autumnupdate - updates dms objectJSONupdate dms object
/dms/update/{id}POST
as of 2020 Autumnupdate content of dms object

update content of dms object
/dms/update/{id}/content

resource-controller (retrieve resources)

GET
as of 2020 AutumngetIcon - retrieves icon resourceThis request returns an icon resource as SVG image.
/resources/icon/{path}/system/icon/{path

saveGeneralSettings

HTTP status code

Insert excerpt

	POST /api-web/api/users/settings
	POST /api-web/api/users/settings
nopanel	true

/api-web/api/users/settings

GET
as of 2020 Autumn

getLocalizedTextResources - retrieves text resourcesThis request retrieves localized text resources for the Accept-Language.
/resources/text

system-controller (manage global resources)

GET
as of 2020 Autumn

getForm - retrieves form by object typeJSON

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.
/system/form/{objecttype}

POST
as of 2020 Autumn

postForm - saves not enriched form

JSON

Saves not enriched form.
/system/form/{objecttype}

GET
as of 2020 Autumn

getIcon - retrieves icon resource

SVGThis request returns an icon resource as SVG image.
GET
as of 2020 Autumn

getLocalizedTextResources - retrieves text resources

JSONThis request retrieves localized text resources for the Accept-Language.
/system/resources/textPOST
as of 2020 AutumnpostLocalizedTextResources - updates text resourcesJSONThis 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 global resources.
/system/resources/text/languages

user-controller - manger user specific information

getSettings

JSON

Insert excerpt

	GET /api-web/api/users/settings/{section}
	GET /api-web/api/users/settings/{section}
nopanel	true

/api-web/api/users/settings/{section}

POST
as of 2020 Autumn

postIcon - updates the icon resource

SVGThis Request update icon for the specified path.
/system/resources/icon/{path}

saveSettings

HTTP status code

Insert excerpt

	POST /api-web/api/users/settings/{section}
	POST /api-web/api/users/settings/{section}
nopanel	true

/api-web/api/users/settings/{section}

GET
as of 2020 Autumn

getUserInfo - retrieves the user information by userIdJSONThis Request retrieves the user information of the requested user.
/user/{userId}/infoGET
as of 2020 AutumngetResultListConfiguration - retrieves result list configurationJSONReturns a result list configuration by type.

Inga - result list = hit list

/user/config/result/{type}POST
as of 2020 AutumnsaveResultListConfiguration - saves a result list configuration for a userSaves a result list configuration for the user by type.
/user/config/result/{type}GET
as of 2020 AutumngetGlobalSettings - retrieves the global settings by section nameJSONThis request retrieves the global settings with the section name.
/user/globalsettings/{section}POST
as of 2020 AutumnsaveGlobalSettings - saves global setting for a sectionSaves a global settings by a section.
/user/globalsettings/{section}

,
deprecateted as of 2023 Spring

getUsers

JSON

Insert excerpt

	GET /api-web/api/users/users
	GET /api-web/api/users/users
nopanel	true

/api-web/api/users/users

GET
as of 2020 Autumn

getGeneralSettings - retrieves the general settings of the userJSONThis request retrieves the general settings of the requested user.
/user/settingsPOST
as of 2020 AutumnsaveGeneralSettings - saves the general setting for the userSaves a general settings for the user.
/user/settingsGET
as of 2020 AutumngetSettings - retrieves the settings of requested userJSONThis 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 AutumnsaveSettings - saves user setting by sectionSaves 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 AutumngetUsers - retrieves user matching the search stringJSONThis Request retrieves all users matching the search string.
/user/usersGET
as of 2020 AutumnwhoAmI - retrieves current user's infoJSONThis request retrieves the user information of the current logged in user.

Das Lesen von Benutzernamen und E-Mail etc.

/user

,
deprecateted as of 2023 Spring

whoAmI

JSON

Insert excerpt

	GET /api-web/api/users/whoami
	GET /api-web/api/users/whoami
nopanel	true

/api-web/api/users/whoami

Versions Compared

Old Version 1

New Version Current

Key

admin-controller (manage tenant resources)

bpm-controller (manage process instances)

dms-controller (manage DMS objects)

resource-controller (retrieve resources)

system-controller (manage global resources)

user-controller - manger user specific information