Method description
Update an existing synonym for this instance.
Security
The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN or SEARCH_MANAGER role for this instance or the global instance.
Request Parameters
None
Request Data
The PUT request must include a single object with the updated synonym data. See Play Service models for details.
The request may include only the fields that are to be updated.
To remove a field (and set the default) set it to null. It is an error to remove a required field or change the synonym type.
Example to disable a link:
{
"enabled": false
}
Response format and codes
| HTTP code | Description |
|---|---|
| 201 | Synonym has been updated |
| 400 | Invalid parameters. Error response will include details |
| 401 | The user does not meet the security criteria |
| 404 | Synonym not found |
The response will contain the updated link data.
{
"type": "catalog",
"lang": "en",
"enabled": false,
"synonyms": [
"yellow"
],
"alternatives": [
"lemon",
"banana"
],
"extra": {
"user": "username"
},
"batched": false,
"id": "586c267572c547cdcb51be9c",
"created_on": "2017-01-03T22:32:21"
"updated_on": "2017-01-03T22:32:21"
}
Dependencies
| service name | purpose |
|---|---|
| MongoDB | simple database storage |