ecm.dms

The ecm.dms namespace contains all operations related to ECM objects: folders, registers, and documents.

Method Description

select()

Returns a HOL query builder (with hierarchy, variants, file info, base parameters).

select_lol()

Returns a LOL query builder (faster for large, flat result sets; no hierarchy, variants, or file properties).

get()

Loads a single object by its ID.

insert()

Creates a new object and returns its ID.

insert_and_get()

Creates a new object and returns the full instance.

update()

Updates an existing object.

update_and_get()

Updates an existing object and returns the updated instance.

upsert()

Returns an upsert builder (XMLImport).

delete()

Deletes an object by its ID.

move()

Moves a document or register to a new location.

copy()

Copies a folder, register, or document to a new location.

files()

Returns the files of a document.

document_stream()

Reads a byte range from a document file (streaming / chunking).

digest()

Returns the digest of a document for integrity verification.

checkout()

Checks out a document, locking it for the current user.

checkin()

Checks in a document, replacing its files and releasing the lock.

undo_checkout()

Undoes a document checkout, releasing the lock.

check_permission()

Checks whether the current user has specific permissions on an object.

history()

Returns the modification history of an object.

set_history()

Adds a custom history entry to an object.

get_object_type_by_id()

Resolves the object type ID for a given object ID.