Process Analytics REST API Services

This section lists and explains the services within the Process Analytics section of the Optimize REST Services API. These services enable users to access process related analytic data that is produced by the Optimize Analytic Engine.

Process Metric Data

This service returns various aggregated process metric data for a specified process and time range. The data is derived from the process instances that were active during the time range. Cycle time statistical calculations can be derived from either the optional statsInterval parameter or from the size of the given range.

The following table lists the time ranges and the statistical intervals.

Time Range	Statistical Interval
<= 12 hours	1 hour
<= 2 days	4 hours
<= 2 weeks	1 day
<= 4 weeks	1 week
> 4 weeks	4 weeks

The URL format is as follows:

http://${optimize host}:${port}/services/rest/api/ProcessAnalytics/ 
ProcessMetrics?processModelId=${processModelId}&startTime=${startTime}&endTime 
=${endTime}&statsInterval=${statsInterval}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The identifier of the process model. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`statsInterval`	String. The statistics interval size. Valid values are "1HOUR", "4HOUR", "1DAY", "1WEEK", "4WEEK". This attribute is not required (if not present, the default is calculated from the time range).

Output Parameters

The following table describes the output parameters.

`cycleTimeAverage`	Returns the cycle time average, in milliseconds, for all process instances that completed during the time range.
`cycleTimeHistoricalAverage`	Returns the cycle time historical average for the relative statistics interval in milliseconds. This is the statistical calculation for the stats interval in which the time range ends.
`cycleTimeMax`	Returns the maximum cycle time for all process instances that completed during the time range in milliseconds.
`cycleTimeMin`	Returns the minimum cycle time for all process instances that completed during the time range in milliseconds.
`cycleTimeStandardDeviation`	Returns the cycle time standard deviation for the relative stats interval in milliseconds. This is the statistical standard deviation for the stats interval in which the time range ends.
`endTime`	Returns the given range time as ISO 8601.
`endTimeAsJavaEpoch`	Returns the range end time as Java epoch.
`ruleViolationCount`	Returns the total rule violations count for the specified process model/time range.
`ruleViolationsOpen`	Returns the count of open rule violations for the specified process model/time range.
`startTime`	Returns the range start time as ISO 8601.
`startTimeAsJavaEpoch`	Returns the range start time as Java epoch.
`volumeCompleted`	Returns the count of processes completed during the time range.
`volumeInProgress`	Returns the count of processes in progress at the end of the time range.
`volumeStarted`	Returns the count of processes started during the time range.

Process Metrics Result Example

<processMetrics>             
   <cycleTimeAverage>0.18</cycleTimeAverage>             
   <cycleTimeHistoricalAverage>0.2</cycleTimeHistoricalAverage>             
   <cycleTimeMax>1200000</cycleTimeMax>             
   <cycleTimeMin>650000</cycleTimeMin>             
   <cycleTimeStandardDeviation>0.2</cycleTimeStandardDeviation>             
   <endTime>2014-08-01T09:46-06:00</endTime>             
   <endTimeAsJavaEpoch>1406907960000</endTimeAsJavaEpoch>             
   <ruleViolationCount>2</ruleViolationCount>             
   <ruleViolationsOpen>1</ruleViolationsOpen>             
   <startTime>2014-05-01T09:46-06:00</StartTime>             
   <startTimeAsJavaEpoch>1398959160000</startTimeAsJavaEpoch>             
   <volumeCompleted>5</volumeCompleted>             
   <volumeInProgress>1</volumeInProgress>             
   <volumeStarted>1</volumeStarted>             
</processMetrics>

Process Instances

This service returns a list of process instances for a specified process and time range. Optionally, a status filter can be specified as well as a maximum results limiter. If the results are truncated by the maxResults limiter, the most recent instances will returned.

The URL format is as follows:

http://${optimize host}:${port}/services/rest/api/ProcessAnalytics/ProcessInstances?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}&status=${status}&maxResults=${maxResults}

Example:

http://localhost:12503/services/rest/api/ProcessAnalytics/ 
ProcessInstances?processModelId=OrderFulfillment&startTime 
=1407996000000&endTime=1408049935760&status=STARTED&maxResults=10

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The identifier of the process model. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`status`	String. The process status by which to filter. Valid values are "ALL", "STARTED", "RUNNING", "COMPLETED". This attribute is not required (defaults to “ALL”).
`maxResults`	String. The maximum number of results. If unlimited results are returned, use 0 or negative number. This parameter is not required (defaults to 5000).

Output Parameters

The following table describes the output parameters.

`processInstanceId`	Returns the identifier for the process instance.
`displayName`	Returns the custom identifier of the process instance, if such exists.
`processModelId`	Returns the identifier for the process model.
`deploymentVersion`	Returns the deployment version of the process.
`processModelType`	Returns the process model type, either "BPM" or "BAM". This indicates whether the process execution was orchestrated by Process Engine or not.
`cycleTime`	Returns the process instance cycle time in milliseconds or -1 if no cycle time is available.
`instanceIteration`	Returns the iteration of the process instance.
`trackingStatus`	Returns the tracking status of the process instance. Valid values are "STARTED", "RUNNING", "COMPLETED", "SUSPENDED", "RESUMED", "CANCELLED", "UNKNOWN".
`processInstanceSeverity`	Returns the process instance severity. Valid values are "NONE", "NO_DATA", "WARNING", "ERROR", "CRITICAL", "INFORMATIONAL".
`startTime`	Returns the process instance start time as ISO 8601.
`startTimeAsJavaEpoch`	Returns the process instance start time as Java epoch.
`endTime`	Returns the process instance end time as ISO 8601 or returns empty if no end time is available.
`endTimeAsJavaEpoch`	Returns the process instance end time as Java epoch or returns -1 if no end time is available.

Process Instances Result Example

<results>             
   <processInstances>             
      <processInstance xmlns:xsi="http://www.w3.org/2001/ 
        XMLSchema-instance" xsi:type="processInstance">             
         <processInstanceId>393x3-389x-ey393-56ez</processInstanceId>             
         <processModelId>Order Fulfillment</processModelId>             
         <processModelType>BAM</processModelType>             
         <deploymentVersion>1</deploymentVersion>             
         <cycleTime>0.2</cycleTime>             
         <instanceIteration>1</instanceIteration>             
         <trackingStatus>RUNNING</trackingStatus>             
         <processInstanceSeverity>NONE</processInstanceSeverity>             
         <startTime>2014-05-01T09:46-06:00</startTime>             
         <startTimeAsJavaEpoch>1398959160000</startTimeAsJavaEpoch>             
         <endTime>16006368-12-25T08:50-0700</endTime>             
         <endTimeAsJavaEpoch>505050050505055050</endTimeAsJavaEpoch>             
      </processInstance>             
   </processInstances>             
   <totalCount>1</totalCount>             
</results>

Process Tracking Errors

Returns a count of process tracking errors that occurred for a specified process and time range. Optimize detects tracking errors during runtime analysis. Tracking errors can be built-in, such as stepOutOfSequence or user defined such as a process timeout.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/ProcessErrors?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The external process model identifier. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.

Output Parameters

The following table describes the output parameters.

`errorTypes`	Returns the process error type.
`errorCount`	Returns the number of error occurrences.

Process Tracking Errors Result Example

<processErrors>            
   <processError>            
      <errorType>Timeout</errorType>            
      <errorCount>22</errorCount>            
   </processError>            
</processErrors>

Step Instances

This service returns step instance data for a specified process, step and time range. Results can be filtered by the status of the step instance, such as completed or running. The step instance includes execution data and tracking data as well as step definition data.

The URL format is as follows:

http://${optimize host}:${port}/services/rest/api/ProcessAnalytics/ 
StepInstances?processModelId=${processModelId}&stepId=${stepId}&startTime 
=${startTime}&endTime=${endTime}&status=${status}&maxResults=${maxResults}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The identifier of the process model. This attribute is required.
`stepId`	String. The identifier of the process model step. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`status`	String. The process status to be returned. Valid values are "ALL", "STARTED", "RUNNING", "COMPLETED". This attribute is not required (defaults to “ALL”).
`maxResults`	String. The maximum number of results. If unlimited results are returned, use 0 or a negative number. This attribute is not required (defaults to 5000).

Output Parameters

The following table describes the output parameters.

`analysisEnabled`	Returns “TRUE” or “FALSE” to indicate whether analysis is enabled for the process.
`deploymentVersion`	Returns the deployment version of the process.
`startTime`	Returns the step start time as ISO 8601.
`startTimeAsJavaEpoch`	Returns the step start time as Java epoch.
`endTime`	Returns the step end time as ISO 8601 or returns empty if no end time is available.
`endTimeAsJavaEpoch`	Returns the step end time as Java epoch or returns -1 if no end time is available.
`processInstanceId`	Returns the identifier for the process instance.
`instanceIteration`	Returns the iteration of the process instance.
`loopIteration`	Returns the loop iteration for the process instance.
`parentinstanceIteration`	Returns the iteration value for the parent process.
`processInstanceStatus`	Returns the status of the process instance. Returned values are "STARTED", "RUNNING", or "COMPLETED".
`processModelId`	Returns the process model identifier.
`processModelType`	Returns the process model type, either "BPM" or "BAM". This indicates whether the process execution was orchestrated by Process Engine or not.
`stepInstanceStatus`	Returns the status of the step instance. Returned values are "RUNNING" or "COMPLETED".
`stepIteration`	Returns the current iteration value of the step.
`stepId`	Returns the identifier of the step.
`stepName`	Returns the name of the step.
`subProcessDeploymentVersion`	Returns the deployment version of the sub-process.

Step Instances Result Example

<results>            
   <stepInstances>            
      <stepInstance xmlns:xsi="http://www.w3.org/2001/ 
          XMLSchema-instance" xsi:type="stepInstance">            
         <analysisEnabled>true</analysisEnabled>            
         <deploymentVersion>1</deploymentVersion>            
         <startTime>2014-07-30T10:25-06:00</startTime>            
         <startTimeAsJavaEpoch>1398959160000</startTimeAsJavaEpoch>               
         <endTime>2014-08-01T09:46-06:00</endTime>            
         <endTimeAsJavaEpoch>1406907960000</endTimeAsJavaEpoch>            
         <processInstanceId>393x3-389x-ey393-56ez</processInstanceId>            
         <instanceIteration>1</instanceIteration>            
         <loopIteration>0</loopIteration>            
         <parentInstanceIteration>0</parentInstanceIteration>            
         <processInstanceStatus>COMPLETED</processInstanceStatus>            
         <processModelId>Order Fulfillment</processModelId>            
         <stepInstanceStatus>RUNNING</stepInstanceStatus>            
         <stepIteration>1</stepIteration>            
         <stepId>S3</stepId>            
         <stepName>Order Receipt</stepName>            
         <subprocessDeploymentVersion>2</subprocessDeploymentVersion>            
      </stepInstance>            
   </stepInstances>            
   <totalCount>1</totalCount>            
</results>

Stage Metric Data

This service returns various aggregated stage metrics for each stage related to the given process. The data is derived from the stage instances that were active during the given time range. Cycle time statistical calculations can be derived from either the optional statsInterval parameter or from the size of the given range.

The following table lists the time ranges and the statistical intervals.

Time Range	Statistical Interval
<= 12 hours	1 hour
<= 2 days	4 hours
<= 2 weeks	1 day
<= 4 weeks	1 week
> 4 weeks	4 weeks

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageMetrics?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}&statsInterval=${statsInterval}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The identifier of the process model. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`statsInterval`	String. The statistics interval size. Valid values are "1HOUR", "4HOUR", "1DAY", "1WEEK", "4WEEK". This attribute is not required (if not provided, the default is calculated from the time range).

Output Parameters

The following table describes the output parameters.

`cancel OnBreach`	Returns an indication of whether the stage will cancel on breach.
`conditionDuration`	Returns the condition duration of the stage in milliseconds.
`cycleTimeAverage`	Returns the cycle time average, in milliseconds, for all stages that completed during the time range.
`endMilestone`	Returns the end milestone name for the stage.
`stageDescription`	Returns the description for the stage.
`stageId`	Returns the identifier for the stage.
`stageName`	Returns the name of the stage.
`startMilestone`	Returns the start milestone for the stage.
`volumeBreached`	Returns the count of breaches for the stage during the time range.
`volumeCompleted`	Returns the count of completed stages during the time range.
`volumeIncomplete`	Returns the count of incomplete stages during the time range.
`volumeRunningCount`	Returns the count of stages running at the end of the time range.
`volumeStarted`	Returns the count of stages started during the time range.

Stage Metrics Result Example

<stageMetrics>            
   <stageMetric>            
      <cancelOnBreach>false</cancelOnBreach>            
      <condition>GREATER_THAN</condition>            
      <conditionDuration>30000</conditionDuration>            
      <cycleTimeAverage>32862</cycleTimeAverage>            
      <endMilestone>Good Credit (S12).Complete</endMilestone>            
      <stageDescription>stage 1</stageDescription>            
      <stageId>18227992-9deb-46b3-b0f7-618ffa2948a5</stageId>            
      <stageName>stage1</stageName>            
      <startMilestone>Validate Credit (S6).Start</startMilestone>            
      <volumeBreached>160</volumeBreached>            
      <volumeCompleted>1160</volumeCompleted>            
      <volumeIncomplete>0</volumeIncomplete>            
      <volumeRunning>0</volumeRunning>            
      <volumeStarted>1160</volumeStarted>            
   </stageMetric>            
<stageMetrics>

Stage Volumes

This service returns stage execution metrics by stage for the specified process and time range. The metrics consist of counts for sages started, running and complete during the specified time range.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageVolumes?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The process model identifier of the process. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.

Output Parameters

The following table describes the output parameters.

`stageId`	Returns the identifier for the stage.
`stageName`	Returns the name of the stage.
`volumeCompleted`	Returns the count of completed stages for the time range.
`volumeIncomplete`	Returns the count of incomplete stages for the time range.
`volumeRunning`	Returns the count of running stages during the time range.

Stage Volume Result Example

<stageVolumes>            
   <stageVolume>            
      <stageId>9abc537f-7c19-4d8e-80f2-f2f778e319ad</stageId>            
      <stageName>AcceptOrderStart-EndOfTheProcess</stageName>            
      <volumeCompleted>2</volumeCompleted>            
      <volumeIncomplete>1</volumeIncomplete>            
      <volumeRunning>1</volumeRunning>            
   </StageVolume>            
   <StageVolume>            
      <stageId>8d127d72-63a2-41b0-abce-e987e8405e42</stageId>            
      <stageName>FindCustomerInfoComplete-ValidateInventoryComplete</stageName>            
      <volumeCompleted>1</volumeCompleted>            
      <volumeIncomplete>0</volumeIncomplete>            
      <volumeRunning>0</volumeRunning>            
   </StageVolume>            
</stageVolumes>

Stage Tracking Errors

This service returns a count of stage tracking errors, also known as breaches, that occurred for a specified process and time range. Counts are grouped by stage.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageErrors?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The process model identifier. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.

Output Parameters

The following table describes the output parameters.

`errorCount`	Returns the error count for the stage.
`stageId`	Returns the identifier for the stage.
`stageName`	Returns the name of the stage.

Stage Errors Result Example

<stageErrors>            
   <stageError>            
      <errorCount>160</errorCount>            
      <stageId>18227992-9deb-46b3-b0f7-618ffa2948a5</stageId>            
      <stageName>stage1</stageName>            
   </stageError>            
</stageErrors>

Stage Cycle Times

This service returns aggregated stage cycle time data for each stage related to the specified process and time range. The data is derived from the stage' instances that were completed during the given time range. Cycle time statistical calculations can be derived from either the optional statsInterval parameter or from the size of the given range.

The following table lists the time ranges and the statistical intervals.

Time Range	Statistical Interval
<= 12 hours	1 hour
<= 2 days	4 hours
<= 2 weeks	1 day
<= 4 weeks	1 week
> 4 weeks	4 weeks

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageCycleTimes?processModelId=${processModelId}&startTime=${startTime}&endTime=${endTime}&statsInterval=${statsInterval}

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The process model identifier of the process. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`statsInterval`	String. The statistics interval size. Valid values are "1HOUR", "4HOUR", "1DAY", "1WEEK", "4WEEK". This attribute is not required (if not provided, the default is calculated from the time range).

Output Parameters

The following table describes the output parameters.

`average`	Returns the cycle time average in milliseconds for all stages that completed during the time range.
`max`	Returns the cycle time maximum in milliseconds for all stages that completed during the time range.
`min`	Returns the cycle time minimum in milliseconds for all stages that completed during the time range.
`historicalAverage`	Returns the cycle time historical average in milliseconds for all stages.
`historicalStdDev`	Returns the cycle time historical standard deviation in milliseconds for all stages.
`stageId`	Returns the identifier for the stage.
`stageName`	Returns the name of the stage.

Stage Cycle Times Result Example

<stageCycleTimes>            
   <stageCycleTime>            
      <average>32862.06896551724</average>            
      <max>37010</max>            
      <min>7901</min>            
      <historicalAverage>2001.9</historicalAverage>            
      <historicalStdDev>109.5</historicalStdDev>            
      <stageId>18227992-9deb-46b3-b0f7-618ffa2948a5</stageId>            
      <stageName>stage1</stageName>            
   </stageCycleTime>            
</stageCycleTimes>

Stage Instances

This service returns stage instance data for a specified process and time range. A set of stage model IDs may also be specified. Results may also be filtered by multiple stage statuses: started, completed, incomplete or breached. An "incomplete" status is a defined as a stage that was started but not completed before the process ended. If no status is given, then all stages that were active during the specified time range are returned.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageInstances?processModelId=${processModelId}&stageIds=${stageIds}&startTime=${startTime}&endTime=${endTime}&status=${status}&maxResults=${maxResults}

Example:

http://localhost:12503/services/rest/api/ProcessAnalytics/StageInstances? 
processModelId=ProcessModels/otc_bus_stages&startTime=1407996000000&endTime= 
1408049935760&status= 
RUNNING,COMPLETE&stageIds=18227992-9deb-46b3-b0f7-618ffa2948a5,67c79edc 
-7498-41c9-a695-b646652572cb&maxResults=10

Input Parameters

The following table describes the input parameters.

`processmodelId`	String. The external process model identifier of the process. This attribute is required.
`stageIds`	The stage IDs, as comma separated. strings. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.
`status`	String. Specifies the stage instance status. Valid values are "RUNNING", "COMPLETE", “INCOMPLETE”. This attribute is no required (defaults to “ALL”).
`maxResults`	Integer. Specifies the maximum number of results. If unlimited results are returned, use 0 or negative number. This parameter is not required (defaults to 5000).

Output Parameters

The following table describes the output parameters.

`breach`	Returns “TRUE” or “FALSE” to indicate whether the stage was breached.
`cycleTime`	Returns the stage instance cycle time in milliseconds or returns -1 if no cycle times are available.
`processInstanceId`	Returns the process instance identifier.
`stageId`	Returns the identifier for the stage.
`stageInstanceId`	Returns the identifier for the stage instance.
`stageName`	Returns the name of the stage.
`startTime`	Returns the stage instance start time as ISO 8601.
`startTimeAsJavaEpoch`	Returns the stage instance start instance time as Java epoch.
`endTime`	Returns the stage instance end time as ISO 8601 or returns empty if no end time is available.
`endTimeAsJavaEpoch`	Returns the stage instance end time as Java epoch or returns -1 if no end time is available.
`stageState`	Returns the state of the stage instance. Valid values are "RUNNING", "COMPLETE", “INCOMPLETE”.

Stage Instances Result Example

<results>           
   <stageInstances>           
      <stageInstance            
      <cycleTime>37000</cycleTime>           
      <processInstanceId>Shift=0&type=stages&instance= 
       2014-08-01T12:01:29.968Z-stagetest1&id=rangeID_00010 
       IterationID_0000100</processInstanceId>           
      <stageId>18227992-9deb-46b3-b0f7-618ffa2948a5</stageId>           
      <stageInstanceId>1875</stageInstanceId>           
      <stageName>stage1</stageName>           
      <startTime>2014-05-01T09:46-06:00</startTime>           
      <startTimeAsJavaEpoch>1398959160000</startTimeAsJavaEpoch>           
      <endTime>2014-08-01T09:46-06:00</endTime>           
      <endTimeAsJavaEpoch>1406907960000</endTimeAsJavaEpoch>           
      <stageState>COMPLETE</stageState>           
   </stageInstance>           
   </stageInstances>           
</results>

Stage Instances for a Process Instance

This service returns stage instance data for a specified process instance.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/StageInstancesForProcessInstance?processInstanceId=${processInstanceId}

Input Parameters

The following table describes the input parameters.

processInstanceId

String. The process instance identifier (external ID or internal database ID). This attribute is required.

Output Parameters

The following table describes the output parameters.

`breach`	Returns “TRUE” or “FALSE” to indicate whether the stage was breached.
`cycleTime`	Returns the average stage instance cycle time for the process instance in milliseconds or returns -1 if no cycle time is available.
`endTime`	Returns the stage instance end time as ISO 8601 or returns empty if no end time is available.
`endTimeAsJavaEpoch`	Returns the stage instance end time as Java epoch or returns -1 if no end time is available.
`processInstanceId`	Returns the process instance identifier.
`stageId`	Returns the identifier for the stage.
`stageInstanceId`	Returns the identifier for the stage instance.
`stageName`	Returns the name of the stage.
`startTime`	Returns the stage instance start time as ISO 8601.
`startTimeAsJavaEpoch`	Returns the stage instance start time as Java epoch.
`stageState`	Returns the state of the stage instance. Valid values are "RUNNING", "COMPLETE", “INCOMPLETE”.

Stage Instances Result Example

<results>           
   <stageInstances>           
      <stageInstance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:type="stageInstance">           
         <breach>false</breach>           
         <cycleTime>37000</cycleTime>           
         <endTime>2014-08-01T12:02-06:00</endTime>           
         <endTimeAsJavaEpoch>1406916129618</endTimeAsJavaEpoch>           
         <processInstanceId>2x5rfd</processInstanceId>           
         <stageId>18227992-9deb-46b3-b0f7-618ffa2948a5</stageId>           
         <stageInstanceId>355</stageInstanceId>           
         <stageName>stage1</stageName>           
         <startTime>2014-08-01T12:01-06:00</startTime>           
         <startTimeAsJavaEpoch>1406916092618</startTimeAsJavaEpoch>           
         <stageState>COMPLETE</stageState>           
      </stageInstance>           
   </stageInstances>           
</results>

Active Process Instance Count for a Point in Time

Returns a count of process instances that were active at the given point in time for a specified process.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/ActiveProcessCountForTime?processModelId=${process
												model Id}&time=${time}

Input Parameters

The following table describes the input parameters.

`processModelId`	String. The process model identifier. This attribute is required.
`time`	Integer or String. A specified point in time (Java long or ISO 8601). This attribute is required.

Output Parameters

The following table describes the output parameters.

`count`	Returns the count of active processes.
`processModelId`	Returns the process model identifier.
`processName`	Returns the name of the process.

Process Count Result Example

<ProcessCount>           
   <count>23</count>           
   <processModelId>Order Fulfillment</processModelId>           
   <processName>Order Fulfillment</processName>           
</ProcessCount>

Active Process Instance Count for Time Range

This service returns a count of process instances that were active for a specified process and time range (inclusive). Active process instances are defined as a process instances that were active at any point in the time range:

Process instances that were started before the time range and ended during the time range.
Process instances that were started before the time range and ended after the time range.
Process instances that were started before the time range and are still running.
Process instances that were started during the time range and ended during the time range.
Process instances that were started during the time range and ended after the time range.
Process instances that were started during the time range and are still running.

The URL format is as follows:

http://${optimize
												host}:${port}/services/rest/api/ProcessAnalytics/ActiveProcessCountForTimeRange?processModelId=${process
												model Id}&startTime=${startTime}&endTime=${endTime}

Input Parameters

The following table describes the input parameters.

`processModelId`	String. The process model identifier. This attribute is required.
`startTime`	Integer or String. The query start time (Java long or ISO 8601). This attribute is required.
`endTime`	Integer or String. The query end time (Java long or ISO 8601). This attribute is required.

Output Parameters

The following table describes the output parameters.

`count`	Returns the count of active process instances.
`processModelId`	Returns the process model identifier.
`processName`	Returns the name of the process.

Process Count Result Example

<ProcessCount>           
   <count>23</count>           
   <processModelId>Order Fulfillment</processModelId>           
   <processName>Order Fulfillment</processName>           
</ProcessCount>