Process/Definitions({FullName})/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.

Simple method to start a new process instance for the specified process definition full name, without any data field values. To start a process instance with data field values, use Process/Instances/StartInstance

  Value Notes
URI {Service Root URI}/Process/Definitions({FullName})/StartInstance?{Query Options}
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Definitions(K2%20Examples_B_Order%20Process)/StartInstance?folio=Order-K2
  • FullName is a string and represents the full name of the process definition. Folder structures with slashes will require you to use Replacement Characters. to specify the path.
  • Custom Query Options
    • Folio (String) – the folio value to assign to the process instance.  Uses current DateTime as default if no value is provided.
Method GET  
Return Type

Process Instance Id (Long) or Failure

  
Return Example <long>3</long>