search()

Sucht Mappen und liefert sie als list[ECMPortfolio]. Alle Kriterien sind optional und werden mit UND verknüpft; ohne Kriterium kommen alle für die Sitzung sichtbaren Mappen zurück.

1. Signatur

  • Sync

  • Async

ecm.portfolio.search(*, portfolio_id: int | None = None, creator: str | None = None,
                     recipient: str | None = None, subject: str | None = None,
                     created: datetime | None = None, created_to: datetime | None = None,
                     object_type_id: int | None = None,
                     garbage_mode: bool = False) -> list[ECMPortfolio]
await ecm.portfolio.search(...) -> list[ECMPortfolio]

2. Parameter

Parameter Typ Standard Beschreibung

portfolio_id

int | None

None

ID einer einzelnen Mappe. Für den Einzelzugriff ist get() bequemer.

creator

str | None

None

Anmeldename des Erstellers.

recipient

str | None

None

Anmeldename des Empfängers.

subject

str | None

None

Titel der Mappe.

created

datetime | None

None

Exakter Anlagezeitpunkt, gelesen als Wandzeit der Installation.

created_to

datetime | None

None

Obergrenze für den Anlagezeitpunkt. None lässt den Zeitraum offen (Created_to=0).

object_type_id

int | None

None

Nur Mappen, die auf diesen Objekttyp beschränkt sind.

garbage_mode

bool

False

True durchsucht den Papierkorb statt der aktiven Mappen.

3. Rückgabe

list[ECMPortfolio], leer wenn nichts passt. Felder siehe Übersicht.

4. Beispiel

from datetime import datetime

# Alle Mappen eines Erstellers
meine = ecm.portfolio.search(creator="ROOT")

# Ältere Mappen zum Aufräumen finden
alt = ecm.portfolio.search(creator="ROOT", created_to=datetime(2024, 1, 1))

# Gelöschte Mappen im Papierkorb
geloescht = ecm.portfolio.search(creator="ROOT", garbage_mode=True)

for mappe in meine:
    print(mappe.id, mappe.subject, len(mappe.objects))

5. Verwandte Seiten