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

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

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

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

print(response.text)
{
  "stages": [
    {
      "type": "<string>",
      "id": "<string>",
      "label": "<string>",
      "condition": "<string>",
      "skip": true
    }
  ],
  "output": {},
  "outputEncounteredCount": 123
}

Authorizations

​
Authorization
string
header
required

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

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.

Body

The body is of type object.

Response

200 - application/json

OK

The indexed documents, plus additional details for debugging.

​
stages
object[]

The stages executed by the index pipeline.

​
output
object

The executed pipeline stages and their document output.

​
outputEncounteredCount
integer<int64>

The number of documents indexed.