client_types()

Returns all client types defined in the system, via wfm.GetSysClienttypes.

A client type is mandatory when starting a workflow (start_process() and workflow_list()). There is no "all clients" value on the server side: an empty or multi-GUID ClientTypeId is rejected.

1. Signature

  • Sync

  • Async

ecm.workflow.client_types() -> list[ECMClientType]
await ecm.workflow.client_types() -> list[ECMClientType]

2. Return value

A list of ECMClientType objects. Empty list when no client types are defined.

2.1. Data model

ECMClientType

  • id (str) — GUID of the client type

  • name (str) — name of the client type (often a resource string such as OSECM_Client)

3. Example

for ct in ecm.workflow.client_types():
    print(ct.id, ct.name)

win_client = next(ct for ct in ecm.workflow.client_types() if ct.name == "#OSECM_Client#")

4. See also