API-Referenz

Die API ist über die ECM()-Factory zugänglich und in folgende Namespaces unterteilt:

Namespace Beschreibung Referenz

ecm.dms

Ordner-, Register- und Dokumentenoperationen

→ ecm.dms

ecm.security

Benutzer- und Gruppenverwaltung

→ ecm.security

ecm.system

Server-Metadaten und Objektdefinitionen

→ ecm.system

ecm.db

Direkter SQL-Zugriff über ADO

→ ecm.db

1. ECM-Factory

from ecmind_blue_client.ecm import ECM
from ecmind_blue_client.pool import SyncPoolClient

client = SyncPoolClient(servers="<host>:4000:1", username="<username>", password="<password>")
ecm = ECM(client)

Die ECM()-Funktion ist überladen: Ein SyncPoolClient liefert ECMSync, ein AsyncPoolClient liefert ECMAsync.

2. impersonate()

ecm.impersonate(username: str) -> ECMSync | ECMAsync

Gibt eine neue ECM-Instanz zurück, die alle Anfragen mit dem angegebenen Benutzerkontext ausführt ($SwitchContextUserName$). Der ausführende Benutzer benötigt die Systemrolle Kontextwechsel.

Unterstützt sowohl den direkten Aufruf als auch die Verwendung als Context-Manager (with / async with).

  • Sync

  • Async

with ecm.impersonate("john") as ecm_john:
    ecm_john.dms.insert(MyFolder(Title="Test"))
async with ecm.impersonate("john") as ecm_john:
    await ecm_john.dms.insert(MyFolder(Title="Test"))