AquaLogic Analytics Query API Usage Guide

     Previous Next  Open TOC in new window   View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

The Query API SOAP Response

This topic provides a description of the components of a Query API SOAP response.

The Basic Response Body

Every Query API SOAP response contains the following static elements:


  • <return>, which is contained by
  • <executeResultSetQueryResponse>, which is contained by
  • the <Body> element of a standard SOAP envelope

All query results from the Query API service will be contained in this response body:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Header/>
<S:Body>

<ns2:executeResultSetQueryResponse xmlns:ns2="http://www.bea.com/analytics/AnalyticsQueryService">
<return>

</return>
</ns2:executeResultSetQueryResponse>
</S:Body>
</S:Envelope>

The Query Results

The results of the query are contained within the <return> element. These elements are:


  • <results>

    This element represents one row of the result set. It contains a <values> element for each column in the result set. Each <values> element can be of any type, and the actual type is specified in the element attributes. When the result set has multiple columns, the <values> elements are in the same sequence as the <columns> elements.

  • <columns>

    This element describes one column of the result set.

The following is an example Query API SOAP response. This is a possible response to the request in the request example in The Query API SOAP Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Header/>
<S:Body>

<ns2:executeResultSetQueryResponse xmlns:ns2="http://www.bea.com/analytics/AnalyticsQueryService">
<return>

<results>
    <values 
        xmlns:xs="http://www.w3.org/2001/XMLSchema" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xsi:type="xs:int">7</values>

    <values 
        xmlns:xs="http://www.w3.org/2001/XMLSchema" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xsi:type="xs:string">Publisher Administration</values>

    <values 
        xmlns:xs="http://www.w3.org/2001/XMLSchema" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xsi:type="xs:int">246</values>

    <count>0</count>
</results>

<columns>count(*)</columns>
<columns>portlet.name</columns>
<columns>portlet.id</columns>

</return>
</ns2:executeResultSetQueryResponse>
</S:Body>
</S:Envelope>

  Back to Top      Previous Next