wfm.ChangeWorkflowState

This job changes/sets the status of a workflow model.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`OrganisationId`	STRING	Yes	ID of the organization to which the workflow is assigned
`WorkflowId`	STRING	Yes	ID of the workflow model
`UserId`	STRING	Yes	ID of the user
`State`	INT	Yes	New status of the workflow model to be set (see below)

OrganisationId

STRING

Yes

ID of the organization to which the workflow is assigned

WorkflowId

STRING

Yes

ID of the workflow model

UserId

STRING

Yes

ID of the user

State

INT

Yes

New status of the workflow model to be set (see below)

Name Type Dependency Description

Name	Type	Dependency	Description
`State`	INT	—	New status of the workflow model

State

INT

—

New status of the workflow model

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

Status values of a workflow model:

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.