Method description
Get a list of synonyms for this instance filtering by keywords. 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 |
---|---|---|
keywords | Filter by this keywords |
Response format and codes
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": [ { "keyword": "yellow", "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" }, ... ] }, ... }