Skip to main content
PUT
/
collections
/
{collection}
/
synonyms
/
{path}
/
items
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "mapping": "<string>",
  "category": "<string>",
  "enabled": false,
  "modified": "2023-11-07T05:31:56Z",
  "user": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
fusion-user-name
string

The Fusion user for authentication

Path Parameters

​
collection
string
required

The name of a collection

​
path
string
required

The path to a synonym file

Pattern: .*
​
id
string
required

The unique ID of the synonym entry

Query Parameters

​
commit
boolean
default:true

If true, commit the change to Solr immediately instead of asynchronously

Body

application/json

JSON-formatted synonym entries

​
id
string
​
mapping
string
​
category
string
​
enabled
boolean
default:false
​
modified
string<date-time>
​
user
string

Response

200 - application/json

successful operation

​
id
string
​
mapping
string
​
category
string
​
enabled
boolean
default:false
​
modified
string<date-time>
​
user
string
​
type
enum<string>
read-only
Available options:
EXPLICIT,
EQUIVALENT