Versions Compared

Key

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

...

...

...

...

Method description

Delete a synonym from an instance.

Security

The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN or SEARCH_MANAGER role for this instance or the global instance.

Parameters

None

Response codes

...

Response format

A 200 OK response will contain a single object with the deleted synonym data.

...

specific synonym for the client {instance_id}.

URI Parameters

None

Responses

200 - item has been deleted

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
    "alternatives": null,
    "batched": false,
    "created_on": "2017-08-08T15:27:29",
    "enabled": true,
    "synonyms": ["extra": {
        "user": "-"
    },
    "id": "yellow5989d8611f3319000b833519",
     ],"lang": "en",
    "alternativessynonyms": [
        "lemon",
        "banana",
        "yellow"
      ],
    "extratype": {"color",
    "userupdated_on": "username"
  }2017-08-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,
  "batched": falsedetails": "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.",
  "idmessage": "586c267572c547cdcb51be9cUnauthorized",
  "created_onstatus": "2017-01-03T22:32:21""error"
}
404 - the instance or item doesn't exist

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 404,
  "details": "Invalid id '123456'",
  "updated_onmessage": "Not "2017-01-03T22:32:21Found",
  "status": "error"
}