requestProcessTemplateMeasure

This operation returns the number of process instances that changed to the specifed states, for the given process template, during the granularity period.

You can check for the following state change:

  • STARTED
  • COMPLETED
  • SUSPENDED
  • CANCELLED
  • FAILED

Note that the counts returned by this operation are deltas, that is, it is the number that changed to each state during the period, not the number that were in that state during the period.

Each state change count is returned inside of an <entry element, inside of the <period element that represents the granularity period (see Granularity).

The following example response from a requestProcessTemplateMeasure operation shows that 15 instances of CSCallbackProcess were started, and 12 were completed, during the first granularity period (index=0):

Response:
...
<measure xmlns="">
   <index>0</index>
   <id xmlns:api="http://api.ec.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
      <processTemplateName>CSCallbackProcess</processTemplateName>
   </id>
<period>
   <index>0</index>
   <duration>
      <startDate>2011-08-27T00:00:00.000Z</startDate>
   </duration>
   <entry>
      <index>0</index>
      <value>15</value>
      <type>STARTED</type>
   </entry>
   <entry>
      <index>1</index>
      <value>12</value>
      <type>COMPLETED</type>
   </entry>
...

For additional information, see requestProcessTemplateMeasure.