wfm.GetWorkflowList

This job returns a list of all startable workflows for the specified user.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

UserId

STRING

Yes

ID of the user

Flags

INT

Yes

Marker parameter — currently only value 48 valid

ClientTypeId

STRING

Yes

ID of the client type used

2. Output Parameters

Name Type Dependency Description

Workflows

BASE64

—

List of data for the requested workflows in XML format (see below)

3. Return Value

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

4. Example

Structure of Workflows:

<Workflows>
  <Workflow FamilyId="" ModelName="" Name="" Id="" Description="" IconId=""/>
  <Workflow FamilyId="" ModelName="" Name="" Id="" Description="" IconId=""/>
</Workflows>

Workflow structure:

  • FamilyId (STRING): ID of the workflow family of the workflow

  • Id (STRING): ID of the workflow

  • Name (STRING): Name of the workflow (instance name)

  • Description (STRING): Description of the workflow model

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

  • ModelName (STRING): Name of the workflow model

5. See Also

wfm.GetOrganisations, wfm.GetOrganisationObjects, wfm.CreateProcessInstance