Skip to main content
POST
/
index-pipelines
/
{id}
/
collections
/
{collection}
/
index
Index a document (deprecated)
import requests

url = "https://{FUSION HOST}/api/index-pipelines/{id}/collections/{collection}/index"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.lucidworks-document"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
contentType
string
default:application/octet-stream

MIME type

Path Parameters

​
id
string
required

The index pipeline ID

​
collection
string
required

The collection ID

Query Parameters

​
simulate
boolean
default:false

Run the pipeline in "simulate" mode for these docs. Stages with "side-effects" are skipped.

​
echo
boolean
default:true

If true, indexed documents are included in the response.

​
echoMaxCount
integer<int32>
default:-1

The number of documents to include in the response, with -1 implying "all".

​
bufferDocsForSolr
boolean

If true, the SolrIndexStage buffers docs.

​
throwOnError
boolean
default:true

Indicates if the indexing should proceed if an error is encountered or if it should throw an exception.

​
params
object
required

Indexing request parameters. The parameters of the indexing request.

​
stats
boolean
default:false

Return statistics about pipeline processing events.

​
autoDetectFormat
string

Deprecated.

​
parserId
string
default:_system

(Deprecated) Id of the parser to be used. Use async-parser instead.

​
skipParsing
boolean
default:false

Skip the parsing and treat document as byte stream.

​
contentSourceName
string
default:unknown

The filename on the source system.

Body

The body is of type object.

Response

OK

The response is of type object.