workflow_by_name()

Löst einen Workflow anhand seines Modellnamens (ModelName) zu genau einem ECMWorkflow auf — analog zu ecm.dms.model_by_name. Intern wird workflow_list() aufgerufen und nach model_name gefiltert.

1. Signatur

  • Sync

  • Async

ecm.workflow.workflow_by_name(
    model_name: str,
    user: ECMOrganisationObjectIdLike,
    client_type: str | ECMClientType,
    organisation: str | ECMOrganisation | None = None,
) -> ECMWorkflow
await ecm.workflow.workflow_by_name(
    model_name: str,
    user: ECMOrganisationObjectIdLike,
    client_type: str | ECMClientType,
    organisation: str | ECMOrganisation | None = None,
) -> ECMWorkflow

2. Parameter

Parameter Typ Standard Beschreibung

model_name

str

—

Der zu suchende Workflow-Modellname (ECMWorkflow.model_name).

user

str | ECMOrganisationObject | ECMOrganisationObjectRef

—

Der Workflow-Organisations-Benutzer (siehe workflow_list()).

client_type

str | ECMClientType

—

Client-Typ als ECMClientType, GUID oder Name. Pflichtparameter.

organisation

str | ECMOrganisation | None

None

Bei None wird die aktive Organisation verwendet.

3. Rückgabewert

Der einzelne passende ECMWorkflow (siehe Datenmodell in workflow_list()).

4. Fehler

  • ECMNotFoundException — kein Workflow mit diesem Modellnamen

  • ECMWrongStateException — mehrere Workflows mit diesem Modellnamen (mehrdeutig; die Meldung listet die kollidierenden `family_id`s)

5. Beispiel

wf = ecm.workflow.workflow_by_name("test", user, "#OSECM_Client#")
print(wf.family_id)

6. Siehe auch