Process/Instances/StartInstance

This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies, legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five, these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five. These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

Starts a new process instance with the data posted.

  Value Notes
URI {Service Root URI}/Process/Instances/StartInstance?{Query Options}
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Instances/StartInstance?synchronous=false

 
Method POST This method cannot be called via URI construction in the address bar of standard browsers.  Tooling such as Fiddler or .NET code may be required to execute the POST
Request Headers Authorization: Basic {encrypted token goes here}
Content-type: application/xml

Ensure that the request has at least these headers set.

  • Authorization – Basic or NTLM (Windows)
  • Content-type – application/xml
Request Body   The request body contains the ProcessInstance item represented as XML.  The ProcessInstance item XML returned from Process GET methods can be used as a starting point for the XML input of this POST method.  Any invalid elements or attributes will be ignored
Request Body Example <w:ProcessInstance
    xmlns:w="http://schemas.k2.com/worklist/d1"
    xmlns:p="http://schemas.k2.com/process/d1" ExpectedDuration="20" FullName="K2 Examples\Order Process" Folio="Order-ACME" Priority="3">
    <p:DataField Name="MyProcessDataField">Some process data value</p:DataField>
    <p:XmlField Name="MyProcessXMLField">
        <XmlDocument>Some Process XML document</XmlDocument>
    </p:XmlField>
</w:ProcessInstance>
 
Namespaces

The ProcessInstance XML requires namespaces to be defined.

  • xmlns:w="http://schemas.k2.com/worklist/d1" (required) – contains the process instance and nodes
  • xmlns:p="http://schemas.k2.com/process/d1" (optional) – contains the nodes for process and activity data fields when provided

 
Elements and Attributes
  • <ProcessInstance>
    • @FullName (String, required) – the name of the process definition to start an instance of in Folder\Name format
    • @ExpectedDuration (Integer) – a expected duration in minutes to assign to the process instance
    • @Priority (Integer) – the priority to assign to the process instance.
      • 0 - High priority
      • 1 - Medium priority
      • 2 - Low priority
      • 3 - Undefined priority
      • NULL - NULL
    • @Folio (String) – the folio value to assign to the process instance.  Uses current DateTime as default if no value is provided.
    • <DataField> (XML) – data field values are XML formatted.  In .Net use XmlConvert.ToString to get the string value otherwise use XmlConvert.To[Type] to get the actual value.
    • <XmlField> (XML) – XML field values are XML escaped.  In .Net use XML objects to get the value: XmlDocument.InnerText, XmlReader.InnerText, XmlWriter.InnerText, or XDocument.Value.
  
Return Type

ProcessInstanceId or Failure 

Due to the asynchronous nature of the POST, a successful call may not return anything depending on the tooling used to execute the POST
Return Example <long>3</long>