Store original text

Store the original text and facet values used for highlighting and aggregation. This does not make the text searchable.

POST /v1/tenants/{tenant}/fts/{table}/{field}/doc

Save text for highlights and facetsStoring the original text does not create searchable terms.

Identify the source documentUse the same ID as its indexed entry.
Save text and facet valuesPreserve content for highlighting and aggregation.
Index terms separatelySearch needs the separate document-indexing operation.

Before you start

Use your database bearer token.

Store the text and facets for the same document ID used by your index. Call Index a document separately to make that text searchable.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`table`	`string`	Required
`field`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

facets maps a facet name to string values, for example {"color": ["red"], "tags": ["a", "b"]}.
Stored text is used for highlighting. This operation does not create the terms used by search.

Field	Type	Required
`doc_id`	`string`	Required
`facets`	`object`	Optional
`text`	`string`	Required

Read the result

Success is 201 with an empty body. This saves original text and facet values for later highlighting or aggregation. It does not add searchable terms; index the document separately.

Response statuses

HTTP status reference

Status	What to do
201	Created
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
409	Resolve the conflict before retrying.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/fts/demo_docs/body/doc" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "doc_id": "p1",
  "text": "Trail mug with insulated steel",
  "facets": {
    "category": [
      "outdoor"
    ]
  }
}'

Response example

Examples use synthetic values to show the response format.

Response status

HTTP/1.1 201

No response body specified by the contract.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link