Process/Instances({ProcessInstanceID})

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.

Returns a single process instance for the matching ProcessInstanceID.

  Value Notes
URI {Service Root URI}/Process/Instances({ProcessInstanceID})
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Instances(5)
  • {ProcessInstanceID } is a Integer and is the identifier of the process instance
  • Custom Query Options – by default worklist item detail data will not be returned.  Changing either the service configuration (web.config) or providing these query options can override whether detail data.
      • piDataField (Boolean) – determines if process level data fields should be returned
      • piXmlField (Boolean) – determines if process level XML fields should be returned
  • Optional Query Options:
    System Query Options
Method GET  
Return Type

ProcessInstance or Failure

  
Return Example <ProcessInstance ExpectedDuration="60" Folder="K2 Examples" Folio="Order-ACME-Updated" FullName="K2 Examples\Order Process" Guid="b8cf5da7-7cf9-4af2-abc6-7fb91a69354c" ID="8" Name="Order Process" Priority="1" StartDate="2011-02-16T04:52:47.687Z" Status="Active"
    xmlns="http://schemas.k2.com/worklist/d1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Description
        xmlns="http://schemas.k2.com/process/d1"/>
        <Metadata
            xmlns="http://schemas.k2.com/process/d1">Blank
        </Metadata>
        <DataField Name="MyProcessDataField"
            xmlns="http://schemas.k2.com/process/d1">Some process data value
        </DataField>
        <XmlField Name="MyProcessXMLField"
            xmlns="http://schemas.k2.com/process/d1">
            <XmlDocument>Some Process XML document</XmlDocument>
        </XmlField>
</ProcessInstance>