checkout()

Checkt ein Dokument über DMS.CheckOutDocument aus. Sperrt das Dokument für den aktuellen Benutzer, sodass kein anderer Benutzer es ändern kann, bis es wieder eingecheckt oder das Auschecken rückgängig gemacht wird.

1. Signatur

  • Sync

  • Async

ecm.dms.checkout(
    model: ECMDocumentModel | int,
    object_type_id: int | None = None,
) -> None
await ecm.dms.checkout(
    model: ECMDocumentModel | int,
    object_type_id: int | None = None,
) -> None

2. Parameter

Parameter Typ Standard Beschreibung

model

ECMDocumentModel | int

—

Entweder eine ECMDocumentModel-Instanz (deren id wird verwendet) oder eine numerische Dokument-Objekt-ID.

object_type_id

int | None

None

Die numerische Objekttyp-ID. Wenn None, wird der Typ automatisch über get_object_type_by_id() ermittelt. Durch Angabe wird ein zusätzlicher Server-Roundtrip vermieden.

3. Rückgabewert

None.

4. Ausnahmen

Ausnahme Bedingung

ValueError

model ist eine ECMDocumentModel-Instanz mit id gleich None.

ECMNotFoundException

object_type_id ist None und kein Objekt mit der angegebenen ID existiert auf dem Server.

ECMWrongStateException

Das Dokument hat keine Seiten oder ist bereits ausgecheckt.

5. Beispiele

5.1. Dokument aus einem Abfrageergebnis auschecken

  • Sync

  • Async

doc = ecm.dms.select(InvoiceDocument).where(InvoiceDocument.Title == "Invoice").execute()[0]
ecm.dms.checkout(doc)
doc = (await ecm.dms.select(InvoiceDocument).where(InvoiceDocument.Title == "Invoice").execute())[0]
await ecm.dms.checkout(doc)

5.2. Auschecken per plain ID mit bekanntem Typ

  • Sync

  • Async

ecm.dms.checkout(12345, object_type_id=327685)
await ecm.dms.checkout(12345, object_type_id=327685)

6. Siehe auch

  • undo_checkout() — Auschecken eines Dokuments rückgängig machen

  • files() — Dateien eines Dokuments herunterladen