Interactions with IDOL components are structured according to the Autonomy Content Infrastructure (ACI) architecture. The ACI architecture defines how clients communicate with the IDOL Server and how IDOL Server responds. In these interactions, clients submit ACI requests to IDOL components as GET or POST HTTP requests, and receive ACI responses in the form of XML or JSON.
An ACI request consists of an ACI action and a collection of ACI parameters. See Send Actions to IDOL.
For example, the following ACI request sends an action to a local IDOL Server on port 9000. The action is Query
, and there are two ACI parameters, Text
with a value of HPE IDOL
, and MaxResults
with a value of 20
.
http://localhost:9000/action=Query&text=HPE IDOL&MaxResults=20
The ACI action determines the collection of valid ACI parameters. For a given ACI action, some ACI parameters might be required while others are optional.
The ACI responses in XML use a uniform structure for the top two levels of the document tree. For example:
<autnresponse xmlns:autn=”http://schemas.autonomy.com/aci/”> <action>QUERY</action> <response>SUCCESS</response> <responsedata>...</responsedata> </autnresponse>
Every ACI response returns the <autnresponse>
node, defines the autn
namespace as shown, and has three children of the document root:
<action>
|
|
<response>
|
SUCCESS or ERROR indicating whether the ACI request succeeded or failed. |
<responsedata>
|
|
|