Connector Framework Server 25.1
Connector Framework Server Help

# Ingest

The `Ingest` action is used for passing documents and document metadata to CFS. `Ingest` is an asynchronous action.

## Parameters

The `Ingest` action takes the following parameters:

Parameter Name | Description
--- | ---
adds | An XML string containing the documents to be added to the index.
removes | A comma separated list of references for documents that should be deleted.
updates | An XML string containing data that should be updated in the index.

## Response

The following XML is a sample response from the `Ingest` action:

    <autnresponse xmlns:autn='http://schemas.autonomy.com/aci/'>
    	<action>INGEST</action>
    	<response>SUCCESS</response>
    	<responsedata>
    		<token>MTAuMi4xMTAuMTQ6NzAwMDpJTkdFU1Q6LTU0MzIyNTEzNQ==</token>
    	</responsedata>
    </autnresponse>

The `Ingest` action is an asynchronous action, so the response is a token. You can use the `QueueInfo` Action to retrieve the status of the action and the response when it is finished:

    <action>
    	<status>Finished</status>
    	<queued_time>2012-Feb-16 11:18:10</queued_time>
    	<time_in_queue>0</time_in_queue>
    	<process_start_time>2012-Feb-16 11:18:10</process_start_time>
    	<time_processing>290</time_processing>
    	<process_end_time>2012-Feb-16 11:23:00</process_end_time>
    	<token>MTAuMi4xMDUuMTE0OjEyODAwOklOR0VTVDotOTYwODA1ODY1</token>
    </action>

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Connector Framework Server 25.1

Topic Title: Ingest