POST
/
index-pipelines
/
{id}
/
collections
/
{collection}
/
debug
{?bufferDocsForSolr,echo,echoMaxCount,params,simulate,throwOnError}
Index a document
curl --request POST \
  --url https://{FUSION HOST}/api/index-pipelines/{id}/collections/{collection}/debug{?bufferDocsForSolr,echo,echoMaxCount,params,simulate,throwOnError} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.lucidworks-document' \
  --data '{}'
{
  "docs": [
    {
      "id": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": {},
          "metadata": {},
          "annotations": [
            {
              "type": "<string>",
              "start": 123,
              "end": 123,
              "features": {},
              "label": "<string>",
              "featureCount": 123
            }
          ]
        }
      ],
      "metadata": {},
      "commands": [
        {
          "name": "<string>",
          "params": {}
        }
      ],
      "hints": {}
    }
  ],
  "stats": {}
}

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 profile 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
default:-1

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

stats
boolean
default:false

Return statistics about pipeline processing events.

bufferDocsForSolr
boolean

If true, the SolrIndexStage buffers docs.

params
object
required

Indexing request parameters.

contentSourceName
string
default:unknown

The filename on the source system.

Body

Response

200 - application/json

OK

The indexed documents, plus statistics about the indexing operation. You can use this data to confirm that the results are as expected.