IDOL 12.13

# IDOL ACI Responses

Interactions with IDOL components are structured according to the Autonomy Content Infrastructure (ACI) architecture. The ACI architecture defines how clients communicate with IDOL components and how the IDOL components respond. 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 Content component on port 9100. The action is `Query`, and there are two ACI parameters, `Text` with a value of `IDOL Server`, and `MaxResults` with a value of `20`.

    http://localhost:9100/action=Query&text=IDOL Server&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>` | contains the ACI action of the request.
`<response>` | contains either `SUCCESS` or `ERROR` indicating whether the ACI request succeeded or failed.
`<responsedata>` | contains the rest of the response, the structure of which depends on the ACI action.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL 12.13

Topic Title: IDOL ACI Responses