Initiate¶
Initiates a new workflow instance with the specified arguments.
1 | |
Parameters¶
( string | Xml ) inputData
Specifies the input data of the new instance, as an XML string or Xml node.
string process
Specifies the process of the new instance, either by name or ID number. If not specified, the current process is used.
InitiateOptions options optional
Specifies the options for the new instance.
Returns¶
The first work item of the initiated workflow.
Remarks¶
inputData must be an XML string or Xml; other values are rejected before the process is started. Both camel-case and Pascal-case option names are accepted. If a parent work item is supplied, omitted Culture and TestMode values inherit from that parent instance, and the parent completion identity is retained for the new instance.
The process/task selection must resolve to exactly one start configuration. No matching configuration, or more than one match, raises a script error rather than choosing arbitrarily.