Operation: reporting::widgetGetDrillDownData


General Description

Gets the drill down data associated with this widget.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.f.manageWidgets -- -- db.[default_db].h_sys_reporting_widget.browse
db.[default_db].h_data_measures.browse
db.[default_db].h_data_samples.browse
db.[default_db].h_data_sampledata.browse

Request Message

Input Parameters

The widgetGetDrillDownData method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
widgetId xs:string required once The unique widget id
seriesNum xs:unsignedInt optional
default=0
In case of multi series widgets, Specify the series number for which you want to fetch drill down data for. By default drill down data for first series(indexed 0) will be returned. Please note that drill down data can only be fetched for a single series at a time. This is because, drill down data can be huge and hence needs to be paged, In presence of paging it is not possible to return data from multiple series as paging exists per series.
aggregationFilter xs:string optional
minOccurs=0
maxOccurs=unbounded
If widget brings any aggregate values then you can specify this filter to limit drill down resultset only from the specified aggregations. For e.g in chartMeasure, scoreCard and targetCounter type widget, the aggregation is a 'measureSampleId', for measureGroupBy and sqlGroupBy it is the 'group'. NOTE: this is now deprecated and will be removed soon, Using this will not result in any filtering from now use 'filter' instead.
filter widgetDrillDownAggregationFilter optional If widget brings any aggregate values then you can specify this filter to limit drill down resultset only from the specified aggregations. For e.g in chartMeasure, scoreCard and targetCounter type widget, the aggregation is a 'measureSampleId', for measureGroupBy and sqlGroupBy it is the 'group'
pageInfo pageInfoType optional Controls the paging. If element is not specified first page is returned with a page size specified in system setting "api.xmlmc.maxPageSize"

Input Data


Response Message

Output Parameters

Name Type Attributes Description
widgetData widgetDrilldownDataStructure optional
minOccurs=0
maxOccurs=unbounded
widget drill down data

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by Esp.demo.ServerService, 8.0.0.3162.)