Endpoints of the Web-API gateway for business process management, accessible for any authenticated user.
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 | Purpose | Response Format | Description |
|---|---|---|---|
| GET as of 2021 Summer | getCatalog | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/catalogs/{qname}'. /api-web/api/dms/catalogs/{qname} |
| POST as of 2021 Summer | postCatalog | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /api-web/api/dms/catalogs/{qname}'. /api-web/api/dms/catalogs/{qname} |
| PATCH as of 2021 Summer | updateCatalog | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'PATCH /api-web/api/dms/catalogs/{qname}'. /api-web/api/dms/catalogs/{qname} |
| GET as of 2021 Summer | validateEntries | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/catalogs/{qname}/validate'. /api-web/api/dms/catalogs/{qname}/validate |
| GET as of 2020 Autumn | getForm | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/forms/{objecttype}'. /api-web/api/dms/forms/{objecttype} |
| POST as of 2020 Autumn | create | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /api-web/api/dms/objects'. /api-web/api/dms/objects |
| GET as of 2020 Autumn | getMetadata | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/objects/{id}'. /api-web/api/dms/objects/{id} |
| DELETE as of 2020 Autumn | delete dms object | HTTP status code | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /api-web/api/dms/objects/{id}'. /api-web/api/dms/objects/{id} |
| PATCH as of 2020 Autumn | update | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'PATCH /api-web/api/dms/objects/{id}'. /api-web/api/dms/objects/{id} |
| GET as of 2020 Autumn | getContent | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/objects/{id}/contents/file'. /api-web/api/dms/objects/{id}/contents/file |
| POST as of 2020 Autumn | update content of dms object | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /api-web/api/dms/objects/{id}/contents/file'. /api-web/api/dms/objects/{id}/contents/file |
| GET as of 2020 Autumn | getAllVersions | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/objects/{id}/versions'. /api-web/api/dms/objects/{id}/versions |
| GET as of 2020 Autumn | getMetadata | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /api-web/api/dms/objects/{id}/versions/{version}'. /api-web/api/dms/objects/{id}/versions/{version} |
| POST as of 2020 Autumn | search | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /api-web/api/dms/objects/search'. /api-web/api/dms/objects/search |