Connector Framework Server 23.3

# GetDocumentStatus

Returns the status of a document.

Type: synchronous

Parameter Name | Description
--- | ---
`reference` | The reference of the document that you want to retrieve the status for. For example, if the document was retrieved by the File System Connector the reference is a file path. If the document was retrieved by a Web Connector, the reference is a URL.

## Response

The following XML is a sample response:

    <autnresponse xmlns:autn="http://schemas.autonomy.com/aci/">
      <action>GETDOCUMENTSTATUS</action>
      <response>SUCCESS</response>
      <responsedata>
        <statuses>
          <status>Awaiting indexing.</status>
        </statuses>
      </responsedata>
    </autnresponse>

The `status` element can contain one of the following values:

- `Awaiting import.`
- `Awaiting indexing.`
- `Indexing complete.` - This status does not guarantee that a document is available from IDOL. The document could be queued for indexing, for example.
- `Unknown reference, or one still in the async queue, or one finished indexing sufficiently long ago.` - CFS cannot report the status of a document if the document is waiting in the ingest action queue or if the document was indexed a long time ago. (To avoid unreasonable memory use, CFS keeps a list of the last 100,000 references in the "Indexing complete" state).

Copyright 2023 Open Text
Version 23.3 | Last updated June 2023

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 Connector Framework Server 23.3

Topic Title: GetDocumentStatus