...
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 Summer2020 Autumn | getCataloggetMetadata | JSON | | Insert excerpt |
|---|
| GET /api-web/api/dms/catalogs/{qnameid} |
|---|
| GET /api-web/api/dms/catalogs/{qnameid} |
|---|
| nopanel | true |
|---|
|
/api-web/api/dms/catalogs/{qnameid} |
POSTDELETE
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 | 2020 Autumn | delete dms object | HTTP status code | | Insert excerpt |
|---|
| PATCH DELETE /api-web/api/dms/catalogs/{qnameid}PATCH |
|---|
| DELETE /api-web/api/dms/catalogs/{qnameid} |
|---|
| nopanel | true |
|---|
|
/api-web/api/dms/catalogs/{qnameid} | GET
as of 2021 Summer2020 Autumn | validateEntriesgetContent | JSON | | Insert excerpt |
|---|
| GET /api-web/api/dms/catalogs/{qnameid}/validatecontent |
|---|
| GET /api-web/api/dms/catalogs/{qnameid}/validatecontent |
|---|
| nopanel | true |
|---|
|
/api-web/api/dms/catalogs/{qnameid}/validatecontent |
GET
as of 2020 Autumn | getFormgetAllVersions | JSON | | Insert excerpt |
|---|
| GET /api-web/api/dms/forms/{objecttypeid}/versions |
|---|
| GET /api-web/api/dms/forms/{objecttypeid}/versions |
|---|
| 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/objectsid}/versions |
GET
as of 2020 Autumn | getMetadata | JSON | | api/ | /objects | 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 | versions/{version} | | GET /api-web |
|---|
|
| /api | objects/ | DELETE /api-web/api/dms/objects/{id| /versions/{version} | | nopanel | true |
|---|
|
/api-web/ | api | dms | objects | id | PATCHPOST
as of 2020 Autumn | updatecreate | JSON | | Insert excerpt |
|---|
| PATCH POST /api-web/api/dms/objects/{id}PATCH |
|---|
| POST /api-web/api/dms/objects/{id} |
|---|
| nopanel | true |
|---|
|
/api-web/api/dms/objects/{id}create |
GET
as of 2020 Autumn | getContentgetForm | JSON | | Insert excerpt |
|---|
| GET /api-web/api/dms/objectsform/{idobjecttype}/contents/file |
|---|
| GET /api-web/api/dms/objectsform/{idobjecttype}/contents/file |
|---|
| nopanel | true |
|---|
|
/api-web/api/dms/objectsform/{idobjecttype}/contents/file |
POST
as of 2020 Autumn | update content of dms objectsearch | JSON | | /api | objects/{id}/contents/file | api/ | objects/{id}/contents/file | /api | objects/{id}/contents/fileGET |
PATCH
as of 2020 Autumn | getAllVersionsupdate | JSON | | GET | /api | objects | /versions | GET | api/ | objects | /versions | /api | objects | /versions | GET
POST
as of 2020 Autumn | getMetadataupdate content of dms object | JSON | | GET | /api | objects | versions/{version}GET | api/ | objects | versions/{version} | /api | objects | versions/{version}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 |