You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
Method description
Get a list of synonyms for this instance. The list is paginated.
Security
The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN, SEARCH_MANAGER or SEARCH_ANALYST role for this instance or the global instance.
Parameters
Name | Required | Description |
---|
enabled | | Filter by enabled/disabled state |
lang | | Filter by synonym language |
rows | | See: pagination |
offset | | See: pagination |
HTTP code | Description |
---|
200 | OK. Response follows |
400 | Invalid parameters. Error response will include details |
401 | The user does not meet the security criteria |
404 | See: pagination |
{
"num_found": 123,
"results": [
{
"type": "catalog",
"lang": "en",
"enabled": true,
"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 |