Overview

The XML REST API lets a search client pose a query to the AIE server using HTTP.  AIE"s reply to the client (containing metadata, matching documents, and a copy of the query) is a page of XML that the client can parse in order to display the results.  The results include the query because the process is asynchronous and results of multiple queries might return to the client out of order. 

This page explains the XML syntax of most of the HTTP/REST response.  The XML that describes the query is presented on the XML REST Request page.

To view a typical REST response, pose any query from the AIE Administrator's Debug Search page.

View incoming links.

• Field Collapsing ,
• XML REST API ,
• XML REST Request

Successful Response

<queryResponse time="0" workflowTime="0" totalRows="2">
  <history>
    <string>10.1.5.50:16000/spellCheckQuery.queryParser-1</string>
    ...
  </history>
  <feedback> 
    <queryFeedback name="spellcheck.suggested" stage="index-spellcheck.spellcheck">
      <message>spelling</message>
    </queryFeedback>
    <queryFeedback name="spellcheck.suggested.markedup" stage="index-spellcheck.spellcheck">
      <message>&lt;b&gt;spelling&lt;/b&gt;</message>
    </queryFeedback>
    ...
  </feedback>
  <documents time="0" numberFound="2" maxScore="222000" offset="0">
    <document score="222" routing="1,0" id="2">
      <fields>
        <field name="date" type="date">
          <value>
            <date>2010-04-21T14:29:27.000</date>
          </value>
        </field>
        <field name="title" type="string">
          <value>
            <string>2010-04-21T14:29:27.000</string>
          </value>
        </field>
        ...
      </fields>
    </document>
    ...
  </documents>
  <queryRequest>...</queryRequest>
</queryResponse>

queryResponse

The queryResponse element is the root element returned for a query response.

history

The history element shows the history of workflow stages that processed the query.

feedback

The feedback element provides any feedback information generated by workflow stages during query processing.

queryFeedback

The queryFeedback element contains a single feedback message generated by a workflow stage.

documents

The documents element contains all response documents.

document

The document element contains all fields returned for a matching document.

children

The children element is just a container for the child documents for a root document (if any). Child documents may be attached to a root document when performing join queries for field collapsing.

fields

The fields element is just a container for the fields of a document.

field

The field element represents a returned field and its values.

value

The value element represents a value for a field.

queryRequest

This element represents the transformed query request that generated this response. This is advanced and full xml of this element will not be covered here.

Error Response

This is an example of an error response. The exact format may change in future versions of AIE.

<exceptionResponse clientId="" redelivered="false">
  <attivioException>
    <detailMessage>workflows parameter not specified</detailMessage>
    <errorCode category="CGI_API_PARSER" code="2"/>
    <stackTrace>
      <trace>com.attivio.messages.QueryRequest.create(QueryRequest.java:2253)</trace>   
      ...
    </stackTrace>
  </attivioException>
</exceptionResponse>

exceptionResponse

The exceptionResponse is the root element returned for failed queries.

attivioException

The attivioException element contains the details for an exceptionResponse.

errorCode

The errorCode element contains a error code for an attivioException.