dms-controller Endpoints

Endpoints of the Web-API gateway for document management system, 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	Retrieves the catalog specified by its name `qname`. /api-web/api/dms/catalogs/{qname}
POST as of 2021 Summer	postCatalog	JSON	Updates the tenant-specific catalog specified by its technical name `qname` with the data passed in the request body in JSON format. /api-web/api/dms/catalogs/{qname}
PATCH as of 2021 Summer	updateCatalog	JSON	Updates the existing tenant-specific catalog identified by its name `qname` or creates a modified copy of an existing global catalog, with the data passed in JSON format in the request body. /api-web/api/dms/catalogs/{qname}
GET as of 2021 Summer	validateEntries	JSON	Checks if catalog entries are already in use. Returns an empty list, if no catolog enties are used. /api-web/api/dms/catalogs/{qname}/validate
GET as of 2020 Autumn	getForm	JSON	Retrieves the default form for the object type specified by object type ID `objecttype` and optional query parameters `situation` and `sots` (secondary object types) for the active tenant. /api-web/api/dms/forms/{objecttype}
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. /api-web/api/dms/objects
GET as of 2020 Autumn	getMetadata	JSON	Retrieves the metadata of the DMS object specified by its object ID `id`. /api-web/api/dms/objects/{id}
DELETE as of 2020 Autumn	delete dms object	HTTP status code	Deletes the DMS object specified by its object ID `id`. /api-web/api/dms/objects/{id}
PATCH as of 2020 Autumn	update	JSON	Updates the metadata and/or tags of an existing DMS object specified by its object ID `id` with the data passed JSON format in the request body. /api-web/api/dms/objects/{id}
GET as of 2020 Autumn	getContent	JSON	Retrieves the binary content file assigned to the object specified by its object ID `id`. /api-web/api/dms/objects/{id}/contents/file
POST as of 2020 Autumn	update content of dms object	JSON	Updates the binary content file assigned to the object specified by its object ID `id` with the file passed in the request body. /api-web/api/dms/objects/{id}/contents/file
GET as of 2020 Autumn	getAllVersions	JSON	Retrieves the metadata of all versions of the DMS object specified by its object ID `id`. /api-web/api/dms/objects/{id}/versions
GET as of 2020 Autumn	getMetadata	JSON	Retrieves the metadata of the version `version` of the DMS object specified by its object ID `id`. /api-web/api/dms/objects/{id}/versions/{version}
GET as of 2022 Spring	getOldVersion	JSON	Restores the older version `version` of the DMS object specified by its object ID `id`. /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore
POST as of 2020 Autumn	search	JSON	Retrieves a list of DMS objects matching the search query passed in the request body in JSON format. /api-web/api/dms/objects/search
POST as of 2022 Winter	search and export objects as CSV file	CSV	Retrieves a list of DMS objects matching the search query passed in the request body in CSV format. /api-web/api/dms/objects/export