Configure synonyms

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

Replace a field's synonym dictionaryThis replaces the previous map rather than appending one entry.

Choose the indexed fieldTarget the table field needing equivalent terms.
Map terms to synonymsSend the complete canonical-term dictionary.
Confirm the new mapExpect an empty 201 response.

Before you start

Use your database bearer token.

This replaces the field's complete synonym map. Include every mapping you want to keep.

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

Maps each canonical term to an array of synonym strings;
replaces any previous map for the table field in full.

Field	Type	Required
`synonyms`	`object`	Required

Read the result

Success is 201 with an empty body. The map replaces the previous map for this field; it does not append a single synonym to existing settings.

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/synonyms" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "synonyms": {
    "mug": [
      "cup"
    ],
    "trail": [
      "hike"
    ]
  }
}'

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