...
...
...
...
Method description
Get a specific synonym from an instance.
Security
The calling user must have the SEARCH_MANAGER role for this instance or the global client {instance_id}.
URI Parameters
None
Response codes
| HTTP code | Description |
|---|---|
| 200 | OK. Response follows |
| 401 | The user does not meet the security criteria |
| 404 | Link not found |
Response format
A 200 OK response will contain an object with the link data.
| Code Block | ||
|---|---|---|
| ||
{
"type": "DIRECT",
"title": "Link Title",
"url": "https://example.com",
"keywords": ["one keyword", "another keyword"],
"image": "https://storage-url/aa50a594-a6da-4a82-9d2d-821e312d895f.png",
"lang": "en"
} |
Dependencies
...
Responses
200 - successful information retrieve
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"alternatives": null,
"batched": false,
"created_on": "2017-08-08T15:27:29",
"enabled": true,
"extra": {
"user": "-"
},
"id": "5989d8611f3319000b833519",
"lang": "en",
"synonyms": [
"lemon",
"banana",
"yellow"
],
"type": "color",
"updated_on": "2017-08-08T15:27:29"
} |
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 or item doesn't exist
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"code": 404,
"details": "Invalid id '123456'",
"message": "Not Found",
"status": "error"
} |