Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

Method description

Get a specific synonym from an instance.

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 client {instance_id}.

URI Parameters

None

Response codes

...

Response format

A 200 OK response will contain an object with the link data.

...

languagejs

...

Responses

200 - successful information retrieve

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
    "alternatives": null,
    "batched": false,
    "created_on": "2017-08-08T15:27:29",
    "enabled": true,
    "synonymsextra": {
    [    "user": "yellow"-"
    },
    "lemonid": "5989d8611f3319000b833519",
    "bananalang": "en",
 ],   "extrasynonyms": [
   {     "user":lemon",
        "usernamebanana",
    },    "batched": false,yellow"
      ],
    "idtype": "586c267572c547cdcb51be9ccolor",
    "createdupdated_on": "2017-0108-03T22:32:21"08T15:27:29"
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "updated_on": "2017-01-03T22:32:21"
}

Dependencies

...

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 or item doesn't exist

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 404,
  "details": "Invalid id '123456'",
  "message": "Not Found",
  "status": "error"
}