SOAP API - getChartData

The table summarizes the SOAP API - getChartData.

Request Uses the getChartDataRequest element (from the EventCollectorReportService schema).
Parameter notes
  • filter: Defines the data to be returned in the chart. For information about valid query syntax, see Defining Query Filter Strings.
  • area: The type of data to display in the chart. Must be one of the following:
    • WORK_ITEMS
    • PROCESS_TEMPLATES
    • PROCESS_INSTANCES
    • AUDIT
    • CASE_OBJECTS
  • filterAttributes (Optional): Used to filter the data to be returned:
    • name: The attribute to filter on. The attributes that can be specified depends on the type of data specified in the area attribute. See "Attributes" below.
    • data: The data to filter on in the specified attribute.
  • requiredAttributes: Specific attributes to return for each event found. The attributes that can be specified depends on the type of data specified in the area attribute. See "Attributes" below.

Attributes

Some of the parameters above require an attribute name. The allowable attributes depends on the type of data displayed in the chart. The following links provide lists of attributes for each type of data:

Work items SeeWORKITEM_STATS Option Attributes
Process templates See PROCESS_TEMPLATES Attributes
Process instances See PROCESS_STATS Options Attributes
Events See AUDIT Option Attributes
Cases See CASE_STATS Option Attributes
Response Returns a getChartDataResponse element (from the EventCollectorReportService schema).
Example Request: 
<soapenv:Body>
      <api:getChartDataRequest>
         <base:ChartDataQuery>
            <filter>processTemplateName='ColiseumBooksProcess'</filter>
            <area>PROCESS_INSTANCES</area>
         </base:ChartDataQuery>
         <base:ChartDataOptions>
            <requiredAttributes>
               <attribute>startTime</attribute>
               <attribute>priority</attribute>
               <attribute>userId</attribute>
            </requiredAttributes>
         </base:ChartDataOptions>
      </api:getChartDataRequest>
   </soapenv:Body>
  Response: 
 <SOAP-ENV:Body>
      <getChartDataResponse xmlns="http://api.ec.n2.tibco.com">
         <ChartDataResult xmlns="http://base.api.ec.n2.tibco.com">
            <categories xmlns="">
               <category>startTime</category>
               <category>priority</category>
               <category>userId</category>
            </categories>
            <data xmlns="">
               <dataset>
                  <value>2016-04-08T11:56:51.347Z</value>
                  <value>NORMAL</value>
                  <value>tibco-admin</value>
               </dataset>
            </data>
            <data xmlns="">
               <dataset>
                  <value>2016-04-08T11:56:52.807Z</value>
                  <value>NORMAL</value>
                  <value>tibco-admin</value>
               </dataset>
            </data>
            <data xmlns="">
               <dataset>
                  <value>2016-04-08T11:56:54.650Z</value>
                  <value>NORMAL</value>
                  <value>tibco-admin</value>
               </dataset>
            </data>
            <data xmlns="">
               <dataset>
                  <value>2016-04-08T11:56:56.630Z</value>
                  <value>NORMAL</value>
                  <value>tibco-admin</value>
               </dataset>
            </data>
            <data xmlns="">
               <dataset>
                  <value>2016-04-08T11:56:58.380Z</value>
                  <value>NORMAL</value>
                  <value>tibco-admin</value>
               </dataset>
            </data>
         </ChartDataResult>
      </getChartDataResponse>
   </SOAP-ENV:Body>