wfm.GetWorkflowListByFamily

This job returns all workflow models contained in a workflow family. Within a workflow family, there is always only one model with status = 1.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

FamilyId

STRING

Yes

ID of the workflow family

2. Output Parameters

Name Type Dependency Description

Workflows

BASE64

—

Workflow list in XML format (see below)

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Example

Structure of Workflows:

<Workflows>
  <Workflow Id="" Name="" State="" Creator="" CreationTime=""
            Version="" LockId="" LockName="" LockTime="" Description=""
            IconId=""/>
  <Workflow Id="" Name="" State="" Creator="" CreationTime=""
            Version="" LockId="" LockName="" LockTime="" Description=""
            IconId=""/>
</Workflows>

Workflow structure:

  • Id (STRING): ID of the workflow

  • Name (STRING): Name of the workflow

  • State (INT): Status of the workflow:

    • 1 = The model is in use, i.e. new processes can be started from it.

    • 2 = The model is locked for processing.

    • 3 = The model is being processed, but not locked.

    • 4 = The model is test released.

    • 5 = The model is deleted but still contained in the DB.

    • 6 = The model is released but not in use. No new processes can be started from this model, but running processes are still completed.

  • Creator (STRING): Creator

  • CreationTime (INT): Creation time

  • Version: Version number of the workflow

  • LockId (STRING): ID of the user who locked the workflow

  • LockName (STRING): Name of the user who locked the workflow

  • LockTime (INT): Time of locking

  • Description (STRING): Description of the workflow

  • IconId (INT): Icon ID of the workflow model