workflow_list()

Returns the workflows a user may start, via wfm.GetWorkflowList.

1. Signature

  • 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. Parameters

Parameter Type Default Description

user

str | ECMOrganisationObject | ECMOrganisationObjectRef

—

The workflow-organisation user — not the security user GUID. Look it up via ecm.workflow.organisation_objects() filtered to the user class.

client_type

str | ECMClientType

—

Client type as an ECMClientType, a GUID, or a name. A name is resolved via client_types(). Mandatory — the server rejects an empty client type.

organisation

str | ECMOrganisation | None

None

Organisation as a GUID or ECMOrganisation. Defaults to the active organisation (active_organisation()) when None.

3. Return value

A list of ECMWorkflow objects. Empty list when the user may start no workflows.

3.1. Data model

ECMWorkflow

  • family_id (str) — GUID of the workflow family; this is the value passed as WorkflowId when starting

  • id (str) — GUID of the concrete workflow model

  • name (str) — display / instance name

  • model_name (str) — name of the workflow model; basis for name-based resolution

  • description (str) — description of the model

  • icon_id (int) — icon ID of the model

4. Errors

  • ECMNotFoundException — a client-type name does not exist

  • ECMWrongStateException — a client-type name is ambiguous

5. Example

# client type by name; organisation = active organisation
for wf in ecm.workflow.workflow_list(user, "#OSECM_Client#"):
    print(wf.model_name, wf.family_id)

6. See also