SOAP API - getChart

The table summarizes the SOAP API - getChart.

Request Uses the getChartRequest 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.
  • group: (Optional; default = all audit data is returned): The attribute to further separate the data in the chart. The attributes that can be specified depends on the type of data specified in the area attribute. See "Attributes" below.
  • category: Indicates what to display about the data type specified in the area parameter.
    • attribute: The name of the attribute that contains the data used to construct the chart. The attributes that can be specified depends on the type of data specified in the area attribute. See "Attributes" below.
    • type - Type of data displayed in the chart. Currently, the only valid entry is COUNT (that is, the number of items specified by the other attributes).
  • 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 name of 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.
  • advancedOptions: for internal use only.

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 See WORKITEM_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 getChartResponse element (from the EventCollectorReportService schema).
Example Request: 
<soapenv:Body>
      <api:getChartRequest>
         <base:ChartQuery>
            <filter>processTemplateName="InitiateClaim"</filter>
            <area>PROCESS_INSTANCES/area>
            <group>userId</group>
            <category>
               <attribute>status</attribute>
               <type>COUNT</type>
            </category>
         </base:ChartQuery>
      </api:getChartRequest>
   </soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <getChartResponse xmlns="http://api.ec.n2.tibco.com">
         <ChartResult xmlns="http://base.api.ec.n2.tibco.com">
            <categories xmlns="">
               <category>Offered</category>
               <category>Allocated</category>
               <category>Completed</category>
            </categories>
            <data xmlns="">
               <group>None</group>
               <dataset>
                  <value>10</value>
                  <value>0</value>
                  <value>0</value>
               </dataset>
            </data>
            <data xmlns="">
               <group>User1</group>
               <dataset>
                  <value>0</value>
                  <value>6</value>
                  <value>4</value>
               </dataset>
            </data>
            <data xmlns="">
               <group>User2</group>
               <dataset>
                  <value>0</value>
                  <value>6</value>
                  <value>5</value>
               </dataset>
            </data>
            <data xmlns="">
               <group>User3</group>
               <dataset>
                  <value>0</value>
                  <value>2</value>
                  <value>7</value>
               </dataset>
            </data>
         </ChartResult>
      </getChartResponse>
   </SOAP-ENV:Body>