Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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

NameRequiredDescription
keywords(tick)Filter by this keywords

Response format and codes

HTTP codeDescription
200OK. Response follows
400Invalid parameters. Error response will include details
401The user does not meet the security criteria
404See: 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"
        },
        ...
      ]
    },
    ...
}
  • No labels