undo_checkout()

Macht das Auschecken eines Dokuments über DMS.UndoCheckOutDocument rückgängig. Gibt die durch checkout() gesetzte Sperre frei, ohne Änderungen einzuchecken.

1. Signatur

  • Sync

  • Async

ecm.dms.undo_checkout(
    model: ECMDocumentModel | int,
    object_type_id: int | None = None,
) -> None
await ecm.dms.undo_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 ist derzeit nicht ausgecheckt.

5. Beispiele

5.1. Auschecken eines Dokuments rückgängig machen

  • Sync

  • Async

ecm.dms.undo_checkout(doc)
await ecm.dms.undo_checkout(doc)

5.2. Auschecken per plain ID rückgängig machen

  • Sync

  • Async

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

6. Siehe auch

  • checkout() — Dokument auschecken

  • files() — Dateien eines Dokuments herunterladen