workflow_list()

Gibt die Workflows zurück, die ein Benutzer starten darf, über wfm.GetWorkflowList.

1. Signatur

  • Sync

  • Async

ecm.workflow.workflow_list(
    user: ECMOrganisationObjectIdLike,
    client_type: str | ECMClientType,
    organisation: str | ECMOrganisation | None = None,
) -> list[ECMWorkflow]
await ecm.workflow.workflow_list(
    user: ECMOrganisationObjectIdLike,
    client_type: str | ECMClientType,
    organisation: str | ECMOrganisation | None = None,
) -> list[ECMWorkflow]

2. Parameter

Parameter Typ Standard Beschreibung

user

str | ECMOrganisationObject | ECMOrganisationObjectRef

—

Der Workflow-Organisations-Benutzer — nicht die Security-Benutzer-GUID. Lookup via ecm.workflow.organisation_objects() gefiltert auf die User-Klasse.

client_type

str | ECMClientType

—

Client-Typ als ECMClientType, GUID oder Name. Ein Name wird über client_types() aufgelöst. Pflichtparameter — der Server weist einen leeren Client-Typ ab.

organisation

str | ECMOrganisation | None

None

Organisation als GUID oder ECMOrganisation. Bei None wird die aktive Organisation (active_organisation()) verwendet.

3. Rückgabewert

Eine Liste von ECMWorkflow-Objekten. Leere Liste, wenn der Benutzer keine Workflows starten darf.

3.1. Datenmodell

ECMWorkflow

  • family_id (str) — GUID der Workflow-Familie; dieser Wert wird beim Start als WorkflowId verwendet

  • id (str) — GUID des konkreten Workflow-Modells

  • name (str) — Anzeige-/Instanzname

  • model_name (str) — Name des Workflow-Modells; Basis für die namensbasierte Auflösung

  • description (str) — Beschreibung des Modells

  • icon_id (int) — Icon-ID des Modells

4. Fehler

  • ECMNotFoundException — ein als Name übergebener Client-Typ existiert nicht

  • ECMWrongStateException — ein als Name übergebener Client-Typ ist mehrdeutig

5. Beispiel

# Client-Typ per Name; Organisation = aktive Organisation
for wf in ecm.workflow.workflow_list(user, "#OSECM_Client#"):
    print(wf.model_name, wf.family_id)

6. Siehe auch