Page Comparison

Page Properties

hidden	true
id	DONE

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.
Chris	07 FEB 2022	2022 Spring	added getOldVersion (DOKU-2321)

...

HTTP Method
as of product version

Purpose

Response Format

Description

GET
as of 2021 Summer

getCatalog

JSON

Insert excerpt

	GET /api-web/api/dms/catalogs/{qname}
	GET /api-web/api/dms/catalogs/{qname}
nopanel	true

/api-web/api/dms/catalogs/{qname}

POST
as of 2021 Summer

postCatalog

JSON

Insert excerpt

	POST /api-web/api/dms/catalogs/{qname}
	POST /api-web/api/dms/catalogs/{qname}
nopanel	true

/api-web/api/dms/catalogs/{qname}

PATCH
as of 2021 Summer

updateCatalog

JSON

Insert excerpt

	PATCH /api-web/api/dms/catalogs/{qname}
	PATCH /api-web/api/dms/catalogs/{qname}
nopanel	true

/api-web/api/dms/catalogs/{qname}

GET
as of 2021 Summer

validateEntries

JSON

Insert excerpt

	GET /api-web/api/dms/catalogs/{qname}/validate
	GET /api-web/api/dms/catalogs/{qname}/validate
nopanel	true

/api-web/api/dms/catalogs/{qname}/validate

GET
as of 2020 Autumn

getForm

JSON

Insert excerpt

	GET /api-web/api/dms/forms/{objecttype}
	GET /api-web/api/dms/forms/{objecttype}
nopanel	true

/api-web/api/dms/forms/{objecttype}

POST
as of 2020 Autumn

create

JSON

Insert excerpt

	POST /api-web/api/dms/objects
	POST /api-web/api/dms/objects
nopanel	true

/api-web/api/dms/objects

GET
as of 2020 Autumn

getMetadata

JSON

Insert excerpt

	GET /api-web/api/dms/objects/{id}
	GET /api-web/api/dms/objects/{id}
nopanel	true

/api-web/api/dms/objects/{id}

DELETE
as of 2020 Autumn

delete dms object

HTTP status code

Insert excerpt

	DELETE /api-web/api/dms/objects/{id}
	DELETE /api-web/api/dms/objects/{id}
nopanel	true

/api-web/api/dms/objects/{id}

PATCH
as of 2020 Autumn

update

JSON

Insert excerpt

	PATCH /api-web/api/dms/objects/{id}
	PATCH /api-web/api/dms/objects/{id}
nopanel	true

/api-web/api/dms/objects/{id}

GET
as of 2020 Autumn

getContent

JSON

Insert excerpt

	GET /api-web/api/dms/objects/{id}/contents/file
	GET /api-web/api/dms/objects/{id}/contents/file
nopanel	true

/api-web/api/dms/objects/{id}/contents/file

POST
as of 2020 Autumn

update content of dms object

JSON

Insert excerpt

	POST /api-web/api/dms/objects/{id}/contents/file
	POST /api-web/api/dms/objects/{id}/contents/file
nopanel	true

/api-web/api/dms/objects/{id}/contents/file

GET
as of 2020 Autumn

getAllVersions

JSON

Insert excerpt

	GET /api-web/api/dms/objects/{id}/versions
	GET /api-web/api/dms/objects/{id}/versions
nopanel	true

/api-web/api/dms/objects/{id}/versions

GET
as of 2020 Autumn

getMetadata

JSON

Insert excerpt

	GET /api-web/api/dms/objects/{id}/versions/{version}
	GET /api-web/api/dms/objects/{id}/versions/{version}
nopanel	true

/api-web/api/dms/objects/{id}/versions/{version}

GET
as of 2022 Spring

getOldVersion

JSON

Insert excerpt

	GET /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore
	GET /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore
nopanel	true

/api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore

POST
as of 2020 Autumn

search

JSON

Insert excerpt

	POST /api-web/api/dms/objects/search
	POST /api-web/api/dms/objects/search
nopanel	true

/api-web/api/dms/objects/search

POST
as of 2022 Winter

search and export objects as CSV file

CSV

Insert excerpt

	POST /api-web/api/dms/objects/export
	POST /api-web/api/dms/objects/export
nopanel	true

/api-web/api/dms/objects/export

Versions Compared

Old Version 21

New Version Current

Key