Page Comparison

...

...

...

...

Method description

Create a new synonym for this 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.

Request Parameters

None

Request Data

The POST request must include a single object with the new link data. See Play Service models for details. All non-optional fields must be included in the request.

...

the client {instance_id}.

URI Parameters

None

Requests

Body

application/json

{
  "type": "catalog",
  "lang": "en",
  "enabled": true,
  "synonyms": [
    "yellow"
  ],
  "alternatives": [
    "lemon",
    "banana"
  ],
  "extra": {
    "user": "username"
  }
}

Response format and codes

...

See Play Service models for details. All non-optional fields must be included in the request.

Responses

201 - item has been created

...

When a synonym is successfully created, the response will contain the synonym itself as it has been saved on the database.

Also, a Location header will point to the URL for the synonym that was just created.

...

Type: application/json

{
    "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"
}

Also, a Location header will point to the URL for the boost that was just created.

400 - Invalid parameters. Error response will include details

Type: application/json

{
  "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": 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"
}