Initiate¶
Initiates a new workflow instance with specified arguments.
1 |
|
Parameters¶
( string | Xml ) inputData
Specifies the input data of new instance. Can be specified as xml string or Xml.
string process
Specifies the process of new instance. Can be Name or Id number of process. If not specified current process is used.
InitiateOptions options
Specifies the options of new instance.
Types¶
InitiateOptions¶
Culture
: string
Culture of new instance. If not specified uses the current instance culture.
Initiator
: string
Identity of initiator. If not specified null value used.
Parent
: string
Parent work item. If not specified current work item is set as parent.
Task
: string
Name or Id of task to be initiated. If not specified, uses the Initiator task if found only one exist, otherwise throws error.
TestMode
: boolean
Specifies the initiate in test mode or not. If not specified uses the current instance's test mode state.
Version
: string
Version of process to initiate