wfm.GetWorkflowInfo

This job returns the input parameters (workflow variables) of an active workflow model (status = 1) of the specified workflow family.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization of the workflow model

FamilyId

STRING

Yes

ID of the family of the active workflow model

2. Output Parameters

Name Type Dependency Description

InputParams

BASE64

Input parameters of the model in XML format (see below)

3. Return Value

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

4. Example

Structure of InputParams:

<InputParams>
  <InputParam Id="" Name=""><![CDATA[]]></InputParam>
  <InputParam Id="" Name=""><![CDATA[]]></InputParam>
</InputParams>

InputParam structure:

  • Id (STRING): ID of the input parameter

  • Name (STRING): Name of the input parameter

  • CDATA: Structure of the input parameter

5. See Also