Process/Instances({ProcessInstanceID})
Returns a single process instance for the matching ProcessInstanceID.
URI
{Service Root URI}/Process/Instances({ProcessInstanceID})
https://api.denallix.com:443/K2Services/REST.svc/Process/Instances(5)
Method
GET
Service Path Options
Required
• ProcessInstanceID (Integer) – the identifier of the process instance (ProcInstID)
Query Options
Optional
- 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
Return Type
ProcessInstance or Failure
GET /K2Services/REST.svc/Process/Instances(8)?piDataField=true&piXmlField=true <?xml version="1.0" encoding="utf-8"?><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">&lt;XmlDocument&gt;Some Process XML document&lt;/XmlDocument&gt;</XmlField> </ProcessInstance>