Process/Instances({ProcessInstanceID})/ XmlFields

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 an XML field collection for the Process process matching the specified process instance identifier (ProcessInstanceID).

  Value Notes
URI

{Service Root URI}/Process/Instances({ProcessInstanceID})/XmlFields
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Instances(8)/XmlFields
  • {ProcessInstanceID } is a Integer and is the identifier of the process instance
  • No filters are applied if options are not provided
  • Optional Query Options:
    System Query Options
Method GET  
Return Type

XmlFieldCollection or Failure

  
Return Example <XmlFieldCollection xmlns="http://schemas.k2.com/process/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <XmlField Name="MyProcessXMLField">
    <XmlDocument>Some Process XML document</XmlDocument>
  </XmlField>
</XmlFieldCollection>