check_insert_permission()

Prüft, ob ein Objekt eines bestimmten Typs an einem Ort eingefügt werden darf.

Derselbe Serveraufruf wie check_permission() mit Objekt-ID 0, der Objekttyp ist hier aber Pflicht: er ist der Typ des einzufügenden Objekts, und Typ 0 ist ein echter Ordnertyp und kein neutraler Wert. Er darf daher nie als Standard eingesetzt werden.

1. Signatur

  • Sync

  • Async

ecm.dms.check_insert_permission(
    object_type_id: int | str,
    *,
    read: bool = False,
    write: bool = False,
    execute: bool = False,
    delete: bool = False,
    update: bool = False,
    folder_id: int | str | ECMFolderModel | None = None,
    register_id: int | str | ECMRegisterModel | None = None,
    register_type: int | str | None = None,
) -> bool
await ecm.dms.check_insert_permission(
    object_type_id: int | str,
    *,
    read: bool = False,
    write: bool = False,
    execute: bool = False,
    delete: bool = False,
    update: bool = False,
    folder_id: int | str | ECMFolderModel | None = None,
    register_id: int | str | ECMRegisterModel | None = None,
    register_type: int | str | None = None,
) -> bool

2. Parameter

Parameter Typ Standard Beschreibung

object_type_id

int | str

—

Numerische Typ-ID des einzufügenden Objekts, als int oder als Zeichenkette mit einer Zahl.

read

bool

False

Prüft auf Leseberechtigung für Indexdaten (R).

write

bool

False

Prüft auf Schreibberechtigung für Indexdaten (W). Das ist das Flag, das ein Einfügen benötigt.

execute

bool

False

Prüft auf Öffnen-/Ausführen-Berechtigung (X).

delete

bool

False

Prüft auf Löschberechtigung (D).

update

bool

False

Prüft auf Aktualisierungsberechtigung (U).

folder_id

int | str | ECMFolderModel | None

None

ID des Zielordners oder eine ECMFolderModel-Instanz.

register_id

int | str | ECMRegisterModel | None

None

ID des Zielregisters oder eine ECMRegisterModel-Instanz.

register_type

int | str | None

None

Typ des Zielregisters. 0 bedeutet Ordnerebene, -1 bedeutet registerunabhängig.

Mindestens eines der Flags read, write, execute, delete oder update muss True sein.

3. Rückgabewert

True, wenn das Einfügen erlaubt ist, andernfalls False. Das Ergebnis wird aus dem Ausgabeparameter Access gelesen, genau wie unter Wie der Server das Ergebnis meldet beschrieben.

4. Ausnahmen

Ausnahme Bedingung

ValueError

Keines der Berechtigungsflags ist True, oder object_type_id ist keine Zahl.

ECMException

Der Server meldet einen Fehler.

5. Beispiele

5.1. Darf ein Rechnungsdokument in diesen Ordner?

  • Sync

  • Async

folder = ecm.dms.select(InvoiceFolder).execute()[0]
if ecm.dms.check_insert_permission(327685, write=True, folder_id=folder):
    print("Einfügen in diesem Ordner erlaubt")
folder = (await ecm.dms.select(InvoiceFolder).execute())[0]
if await ecm.dms.check_insert_permission(327685, write=True, folder_id=folder):
    print("Einfügen in diesem Ordner erlaubt")

5.2. Registerort vor dem Einfügen prüfen

  • Sync

  • Async

if ecm.dms.check_insert_permission(327685, write=True, register_id=12345, register_type=196609):
    ecm.dms.insert(InvoiceDocument(Number="2026-0001"), folder_id=98765, register_id=12345)
if await ecm.dms.check_insert_permission(327685, write=True, register_id=12345, register_type=196609):
    await ecm.dms.insert(InvoiceDocument(Number="2026-0001"), folder_id=98765, register_id=12345)

6. Siehe auch