Method description
Get a list of synonyms for this instancethe client {instance_id}. The result 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
...
URI Parameters
Parameter name | Required | Description | ||||
---|---|---|---|---|---|---|
rows | See: Empathy Play API - Pagination | |||||
offset | See: Empathy Play API - Pagination | |||||
enabled | Filter by enabled/disabled state | |||||
lang | Filter by synonym language | |||||
rowskw | See: pagination | offset | See: pagination | Filter by synonym keywords | ||
pkw | Filter by synonym keywords (partial search) |
Response format and codes
...
200
...
- successful information retrieve
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ "num_found": 12378, "results": [ { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:29", "enabled": true, "extra": { "user": "-" }, "id": "5989d8611f3319000b833519", "lang": "en", "synonyms": [ "lemon", "banana", "yellow" ], "type": "catalog"": "color", "updated_on": "2017-08-08T15:27:29" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:29", "enabled": true, "extra": { "user": "-" }, "id": "5989d861e6ece90012a92752", "lang": "en", "synonyms": [ "cyan", "azure", "navy", "blues", "sky", "blue" ], "type": "color", "updated_on": "2017-08-08T15:27:29" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:29", "enabled": true, "extra": { "user": "-" }, "id": "5989d861e6ece90012a92753", "lang": "en", "synonyms": [ "snow", "white", "ivory" ], "type": "color", "updated_on": "2017-08-08T15:27:29" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:29", "enabled": true, "extra": { "user": "-" }, "id": "5989d8611f3319000c833517", "lang": "en", "synonyms": [ "wheat", "yellow"camel", "beige" ], "type": "color", "updated_on": "2017-08-08T15:27:29" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:29", "enabled": true, "extra": { "user": "-" }, "id": "5989d8611f3319000b83351a", "lang": "en", "synonyms": [ "gray", "stone", "smoke", "grey", "slate" ], "type": "lemon", "color", "updated_on": "2017-08-08T15:27:29" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:30", "enabled": true, "extra": { "user": "-" }, "id": "5989d8621f3319000c833518", "lang": "en", "synonyms": [ "chocolate", "tanned", "banana""wood", "brown", "tan" ], "type": "color", "updated_on": "2017-08-08T15:27:30" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:30", "enabled": true, "extra": { "user": "-" }, "id": "5989d862e6ece90012a92754", "lang": "en", "synonyms": [ "maroon", "purple", "magenta", "lavender", "violet", "raspberry" ], "type": "color", "updated_on": "2017-08-08T15:27:30" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:30", "enabled": true, "extra": { "user": "-" }, "id": "5989d862e6ece90011a92759", "lang": "en", "synonyms": [ "night", "black", "dark" ], "type": "usernamecolor", "updated_on": "2017-08-08T15:27:30" }, { "alternatives": null, "batched": false, "created_on": "2017-08-08T15:27:30", "enabled": true, "extra": { "user": "-" }, "id": "5989d862e6ece90012a92755", "lang": "586c267572c547cdcb51be9c", "en", "synonyms": [ "golden", "gold" ], "type": "color", "updated_on": "2017-08-08T15:27:30" }, { "alternatives": null, "batched": false, "created_on": "2017-01-03T22:32:21" -08-08T15:27:30", "enabled": true, "extra": { "user": "-" }, "id": "5989d8621f3319000c833519", "lang": "en", "synonyms": [ "orange", "copper", "sun", "rust", "oranges" ], "type": "color", "updated_on": "2017-0108-03T2208T15:3227:2130" } ] } |
400 - Invalid parameters. Error response will include details
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ "code": 400, "details": "\"rows\" must be in range 10-200", "message": "Bad Request", "status": "error" } |
401 - the user performing the action doesn't meet the security criteria
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ "code": 401, "details": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.", "message": "Unauthorized", "status": "error" } |
404 - the instance doesn't exist or offset is wrong
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ ] }"code": 404, "details": "", "message": "Not Found", "status": "error" } |