wfm.GetWorkflow

This job retrieves a workflow model from the server.

1. Input Parameters

Name Type Required Description

WorkflowId

STRING

Yes

ID of the workflow model

ProcessId

STRING

Yes

ID of the process (process must be active); can be optionally used and replaces the FamilyId and WorkflowId parameters; only valid for Action = 1

OrganisationId

STRING

Yes

ID of the organization of the workflow model

UserId

STRING

Yes

ID of the DMS user

FamilyId

STRING

Yes

ID of the workflow family of the workflow model

Action

INT

Yes

Action to be performed:
1 = workflow model is requested for reading
2 = workflow model should be edited
3 = an empty workflow model is requested

2. Output Parameters

Name Type Dependency Description

NewId

STRING

only for Action = 3

New ID of the requested workflow, if created (see input parameter Action)

State

INT

—

State of the model:
1 = The model is in use, i.e. new processes can be started from it.
2 = The model is locked for editing.
3 = The model is being edited, but not locked.
4 = The model is released for testing.
5 = The model is deleted but still in the database.
6 = The model is released but not in use. No new processes can be started from this model, but running processes will still be completed.

3. Output Files

Name Description

File list

Name and path of the file containing the XML package with the model description in XML format

4. Return Value

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

5. See Also

wfm.StoreWorkflow