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.
insert_variant()	Creates a new variant of an existing document.
insert_variant_and_get()	Creates a new variant and returns the full instance.
variants()	Reads the variant tree of a document, without a model class.
active_variant()	Returns the currently active variant of a document.
set_active_variant()	Switches the active variant of an existing variant tree.
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).
files_streaming()	Streams a document’s files chunk-by-chunk without local buffering (context manager).
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.

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.

insert_variant()

Creates a new variant of an existing document.

insert_variant_and_get()

Creates a new variant and returns the full instance.

variants()

Reads the variant tree of a document, without a model class.

active_variant()

Returns the currently active variant of a document.

set_active_variant()

Switches the active variant of an existing variant tree.

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).

files_streaming()

Streams a document’s files chunk-by-chunk without local buffering (context manager).

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.

1. ID parameters also take strings

Every ID parameter of this namespace takes an int or a string holding one, and converts a string to int before the call goes out. This covers object IDs (object_id, model, document, variant, parent_document_id, previously_active_id) as well as type and location IDs (object_type_id, folder_id, register_id, register_type).

The reason is the route an ID takes through application code: a Flask or FastAPI route parameter, a CSV column, a JSON body, an SQL column read as text — it arrives as a string everywhere. The server does not accept it in that shape: ObjectID is typed and answers a string with -1024 "A job parameter is missing", a thoroughly misleading message, and only after a full round trip. The conversion therefore belongs at the edge of the library rather than in every caller.

folder = ecm.dms.get(InvoiceFolder, "12345")           # same as get(InvoiceFolder, 12345)
doc_id, _ = ecm.dms.insert(doc, folder_id="12345")     # location IDs likewise

A string that is not a number raises ValueError naming the parameter and the value before any job reaches the server. A float raises TypeError rather than being silently truncated to int.

object_type in delete(), move() and copy() is excluded: a string there still means the internal name of the object type (e.g. "word_documents"), not an ID.