Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version
Report Note
AssigneeInga

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.

    (error) LINK to the SWAGGER UI and back ...

Modification History

Add a new line to this table and fill it whenever you edit the page.

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.



Endpoints of the Web-API gateway for business process management, accessible for any authenticated user.


>> API-WEB Service

The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. Most of them internally call the core API.


HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2021 Summer
getCatalogJSON
POST
as of 2021 Summer
postCatalogJSON
PATCH
as of 2021 Summer
updateCatalogJSON
GET
as of 2021 Summer
validateEntriesJSON
GET
as of 2020 Autumn
getFormJSON
POST
as of 2020 Autumn
createJSON
GET
as of 2020 Autumn
getMetadataJSON
DELETE
as of 2020 Autumn
delete dms objectHTTP status code
PATCH
as of 2020 Autumn
updateJSON
GET
as of 2020 Autumn
getContentJSON
POST
as of 2020 Autumn
update content of dms objectJSON
GET
as of 2020 Autumn
getAllVersionsJSON
GET
as of 2020 Autumn
getMetadataJSON
POST
as of 2020 Autumn
searchJSON