REST API - requestProcessTemplateMeasure

The table summarizes the REST API - requestProcessTemplateMeasure.

Request

Format 
POST <baseurl>/statistics/measures/get/process/template/<start>/<end>
Path parameters start, end: Required start and end dates for the measure.
Query parameters
  • granularity=string (optional, default=HOUR): Unit of time used in the measure.
  • consolidation=string (optional, default=NO_CONSOLIDATION): Consolidation mode to be used. See Consolidation for possible values.
Body processTemplateIds element (mandatory): This is an array of process template IDs.

Response

JSON Returns a JSON representation of the content of a ProcessTemplateMeasures element.
XML Returns the content of a ProcessTemplateMeasures element (from the EventCollectorMeasuresService schema).

Example

Request 
POST <baseurl>/statistics/measures/get/process/template/2013-01-28T00:00/2013-01-30T00:00
Request body 
<ProcessTemplateIds>
<id>
<processTemplateName>CMISSampleProcess</processTemplateName>
</id>
</ProcessTemplateIds>
Response 
{
  "measure": {
    "index": "0",
    "isConsolidatedMeasure": "false",
    "id": { "processTemplateName": "CMISSampleProcess" },
    "period": [
      {
        "index": "0",
        "duration": { "startDate": "2013-01-28T00:00:00.000Z" },
        "entry": [
          {
            "index": "0",
            "value": "0",
            "type": "STARTED"
          },
          {
            "index": "1",
            "value": "0",
            "type": "COMPLETED"
          },
          {
            "index": "2",
            "value": "0",
            "type": "SUSPENDED"
          },
          {
            "index": "3",
            "value": "0",
            "type": "CANCELLED"
          },
          {
            "index": "4",
            "value": "0",
            "type": "FAILED"
          },
          {
            "index": "5",
            "value": "0",
            "type": "HALTED"
          }
        ]
      },
.
.
.
,
          {
            "index": "5",
            "value": "0",
            "type": "HALTED"
          }
        ]
      }
    ]
  }
}