Page Comparison

...

...

...

...

Method description

Create a new equalize setting 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.

...

boost for the client {instance_id}.

URI Parameters

None

Request Data

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

...

Requests

Body

application/json

{
  "title": "My Custom Config",
  "fields": [
    {"field": "title", "boost": 80},
    {"field": "description", "boost": 25}
  ]
}

Response format and codes

...

See Empathy Play API - Models for details. All non-optional fields must be included in the request.

Responses

201 - item has been created

...

When an equalize setting is successfully created, the response will contain the equalize itself as it has been saved on the database.

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

...

Type: application/json

{
  "id": 1461321668,
  "title": "My Custom Config",
  "enabled": false,
  "created_on": "2017-04-24T10:28:37",
  "updated_on": "2017-04-24T10:28:37",
  "fields": [
    {"field": "title", "boost": 80},
    {"field": "description", "boost": 25}
  ]
}

Also, a Location header will point to the URL for the equalize 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"
}