Method description
Update an existing 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 PUT request must include a single object with the updated equalize data. See Play Service models for details.
The request may include only the fields that are to be updated.
To remove a field (and set the default) set it to null. It is an error to remove a required field.
Example to enable an equalize setting:
{ "enabled": true }
Response format and codes
HTTP code | Description |
---|---|
201 | Equalize has been updated |
400 | Invalid parameters. Error response will include details |
401 | The user does not meet the security criteria |
404 | Equalize not found |
The response will contain the updated equalize data.
{ "id": 1461321668, "title": "Default", "enabled": true, "created_on": "2017-04-24T10:28:37", "updated_on": "2017-04-24T10:28:37", "fields": [ {"field": "title", "boost": 50}, {"field": "description", "boost": 20}, {"field": "price", "boost": 10} ] }
Dependencies
service name | purpose |
---|---|
MongoDB | simple database storage |