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 2020 Autumn | getMetadata | JSON | Retrieves the metadata of the DMS object specified by its object ID |
| DELETE as of 2020 Autumn | delete dms object | HTTP status code | Deletes the DMS object specified by its object ID |
| GET as of 2020 Autumn | getContent | JSON | Retrieves the binary content file assigned to the object specified by its object ID |
| GET as of 2020 Autumn | getAllVersions | JSON | Retrieves the metadata of all versions of the DMS object specified by its object ID |
| GET as of 2020 Autumn | getMetadata | JSON | Retrieves the metadata of the version |
| POST as of 2020 Autumn | create | JSON | Creates a DMS object with the data passed in the multipart request body including the metadata in JSON structure and optionally a binary content file. |
| GET as of 2020 Autumn | getForm | JSON | Retrieves the default form for the object type specified by object type ID |
| 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 |
| 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} |
| 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 |