POST / POST

/api/dms/objects

Imports DMS objects. One endpoint is Multipart and the other application/json.

yes

3.0.0

DELETE

/api/dms/objects/{objectId}

Deletes a DMS object identified by objectId.

yes

3.0.0

GET

/api/dms/objects/{objectId}

Retrieves the metadata of a DMS object identified by objectId.

yes

3.0.0

PATCH

/api/dms/objects/{objectId}

Updates all metadata, location and/or object type of a DMS object identified by objectId.

yes

3.0.0

POST

/api/dms/objects/{objectId}

Updates all metadata, content, location and/or object type of a DMS object identified by objectId.

yes

3.0.0

GET

/api/dms/objects/{objectId}/contents

Gets the content metadata of a DMS objects identified by objectId.

yes

3.0.0

GET

/api/dms/objects/{objectId}/contents/renditions/pdf

Gets the pdf rendition of the contents of a DMS objects identified by objectId.

yes

5.0.0

GET

/api/dms/objects/{objectId}/contents/renditions/pdf/native/annotated

Gets the pdf of the contents with annotations of a DMS object identified by objectId.

no

6.5.0

GET

/api/dms/objects/{objectId}/contents/renditions/text

Gets the ocr rendition of the contents of a DMS objects identified by objectId.

yes

5.0.0

GET

/api/dms/objects/{objectId}/contents/renditions/thumbnail/{index}

Gets the thumbnail of the first page of the contents of a DMS objects identified by objectId.

yes

5.0.0

GET

/api/dms/objects/{objectId}/contents/file

Gets the content related to a DMS object identified by objectId.

yes

3.0.0

POST

/api/dms/objects/{objectId}/contents/file

Updates the content file of a DMS object identified by objectId.

yes

3.0.0

DELETE

/api/dms/objects/{objectId}/contents/file

Delete the content file of a DMS object identified by objectId.

yes

5.5.0

GET

/api/dms/objects/{objectId}/contents/file/{index}

Retrieves the content element with the given index from the DMS object.

no

3.0.0

POST

/api/dms/objects/{objectId}/contents/file/{index}

Replaces the content element with the given index in the DMS object.

no

3.0.0

PUT

/api/dms/objects/{objectId}/contents/file/{index}

Inserts a content element before the given index in the DMS object.

no

3.0.0

DELETE

/api/dms/objects/{objectId}/contents/file/{index}

Deletes the content element with the given index in the DMS object.

no

3.0.0

GET

/api/dms/objects/{objectId}/contents/native/zip

Retrieves all content elements of the DMS object in a ZIP archive.

no

3.0.0

PATCH

/api/dms/objects/{objectId}/contents/native/lock

Locks (checkout) a document and locks it for content editing.

no

3.3.0

PATCH

/api/dms/objects/{objectId}/contents/native/unlock

Unlocks (undo checkout) a document and therefore the lock for editing the content.

no

3.3.0

GET

/api/dms/objects/{objectId}/contents/native/annotations

Retrieves all annotations which are placed on the content of a DMS object.

no

6.5.0

POST

/api/dms/objects/{objectId}/contents/native/annotations

Insert or Update annotations on the content of a DMS object.

no

6.5.0

DELETE

/api/dms/objects/{objectId}/contents/native/annotations/{annotationId}

Delete annotation on the content of a DMS object.

no

6.5.0

GET

/api/dms/objects/{objectId}/history

Retrieves the history entries of a DMS object identified by objectId.

yes

3.0.2

POST

/api/dms/objects/{objectId}/history

Inserts a custom history entry with the code 470 or 471.

no

3.3.0

GET

/api/dms/objects/{objectId}/versions 

Retrieves the system metadata of all versions of a DMS object.

yes

6.1.0

GET

/api/dms/objects/{objectId}/versions/{versionNumber}

Retrieves the field metadata of a specific version of a DMS object.

yes

6.1.0

DELETE

/api/dms/objects/{objectId}/versions/{versionNumber}

Deletes a content change version of a DMS object.

yes

6.2.0

GET

/api/dms/objects/{objectId}/versions/{versionNumber}/contents/file

Retrieves the content of a content change version of a DMS object.

yes

6.2.0

POST

/api/dms/objects/{objectId}/versions/{versionNumber}/actions/restore

Restores a version of a DMS object.

yes

6.2.0

DELETE

/api/dms/objects/{objectId}/actions/trash

Deletes an object from the recycle bin.

yes

5.3.0

POST

/api/dms/objects/{objectId}/actions/trash/restore

Restores an object from the recycle bin.

yes

5.3.0

GET

/api/dms/objects/{objectId}/native/name

Returns a name for the DMS object based on a hit list configuration.

no

5.4.0

GET

/api/dms/objects/{objectId}/native/locations

Returns all locations in which the DMS object is present.

no

4.0.1

GET

/api/dms/objects/{objectId}/native/variants

Returns all variants for the DMS object identified by objectId.

no

3.1.0

POST

/api/dms/objects/{objectId}/native/variants

Creates a new variant for the DMS object identified by objectId.

no

3.1.0

PUT

/api/dms/objects/{objectId}/native/variants/{activateId}

Activates the variant for the DMS object identified by objectId.

no

3.1.0

GET

/api/dms/objects/{objectId}/native/links

Returns all links of the object to other DMS objects.

no

6.4.0

POST

/api/dms/objects/{objectId}/native/links

Insert or Update links to other DMS objects.

no

6.4.0

DELETE

/api/dms/objects/{objectId}/native/links/{linkedObjectId}

Delete a link to a DMS object.

no

6.4.0

GET

/api/dms/objects/{objectId}/native/notes

Returns all notes for a specific object.

no

6.4.0

POST

/api/dms/objects/{objectId}/native/notes

Insert or Update notes.

no

6.4.0

DELETE

/api/dms/objects/{objected}/native/notes/{noteObjectId}

Delete a note.

no

6.4.0

GET

/api/dms/objects/{objectId}/native/osfile

Returns a byte sequence of the osfile.

no

6.5.0

POST

/api/dms/objects/search

Queries for DMS objects.

yes

3.0.0

POST

/api/dms/objects/search/native

Queries for DMS objects with query syntax of enaio® appconnector.

no

3.0.0

< 6.0.0

POST

/api/dms/objects/native/names

Returns a name for each DMS object based on a hit list configuration.

no

5.4.0

POST

/api/dms/objects/native/contents/zip

Returns a byte sequence of the zip archive.

no

6.4.0

POST

/api/dms/objects/native/contents/pdf

Returns a pdf file with all forwarded documents.

no

6.4.0

GET

/api/dms/schema

Retrieves the schema.

yes

3.0.0

GET

/api/dms/schema/native

Retrieves the complete object definition in the enaio® appconnector format.

no

3.0.0

GET

/api/dms/schema/objecttype/{localname}

Retrieves the definition of the object type identified by localname.

yes

3.0.0

GET

/api/dms/info

Retrieves basic information about platform and version.

yes

3.2.0

GET

/api/dms/info/native

Retrieves basic information plus information about the current user and legacy service endpoints.

no

3.2.0