Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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.

Request 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.

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

Response format and codes

HTTP codeDescription
201Equalize setting has been created
400Invalid parameters. Error response will include details
401The user does not meet the security criteria

 

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.

{
  "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}
  ]
}
  • No labels