Update a synonym entry

Update an entry in a synonyms file.

PUT /collections/{collection}/synonyms/{path}/items/{id}

Update a synonym entry

Python

import requests

url = "https://{FUSION HOST}/api/collections/{collection}/synonyms/{path}/items/{id}"

payload = {
    "id": "<string>",
    "mapping": "<string>",
    "category": "<string>",
    "enabled": True,
    "modified": "2023-11-07T05:31:56Z",
    "user": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

200

{
  "id": "<string>",
  "mapping": "<string>",
  "category": "<string>",
  "enabled": true,
  "modified": "2023-11-07T05:31:56Z",
  "user": "<string>"
}

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 synonyms 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

modified · string<date-time>

user · string

Response

200 - application/json

successful operation

id · string

mapping · string

category · string

enabled · boolean

modified · string<date-time>

user · string

type · enum<string> · read-only

Available options: EXPLICIT, EQUIVALENT