Class: GetMeasureRequest

tibco.objectapi.service.request.GetMeasureRequest

new GetMeasureRequest(processTemplates, area, type, start, end)

Object GetMeasureRequest Usage: RestApiService.getStatisticsService().getMeasure(request, callback);
Parameters:
Name Type Description
processTemplates tibco.objectapi.ec.base.ProcessTemplateIds An array of process template IDs.
area string The measure area. The valid options are "WorkItem" and "Process".
type string The type of measure. For "WorkItem", the only valid option is "Template". For "Process", the valid options are "Template" and "Duration".
start string The start date of the measure (for example: 2015-01-15T00:00).
end string The end date of the measure (for example: 2015-01-31T00:00).
Since:
  • 4.0.0

Members

advancedOptions :string

Query parameter: 'advancedoptions' (For internal use only.)
Type:
  • string
Since:
  • 4.0.0

consolidation :string

Query parameter: 'consolidation' (optional) Specifies the consolidation mode for the measure. The valid entries are:
  • NO_CONSOLIDATION - One measure is returned for each ID passed in by the request. Each measure returned specifies the ID to which it refers.
  • CONSOLIDATE - A single measure is returned, containing the consolidated data for all the ids passed in by the request.
  • BOTH: One measure is returned for each ID passed in by the request. An additional measure is also returned, containing the consolidated data for all the IDs passed in by the request. (The isConsolidatedMeasure attribute in the response can be used to recognize which entry contains the consolidated data.)
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = NO_CONSOLIDATION

granularity :string

Query parameter: 'granularity' (optional) Unit of time used in the measure. The valid entries are: HOUR, DAY, MONTH, YEAR, or WEEK.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = HOUR