...
...
...
...
Method description
Get a list of all blacklists for this instance. If the lang parameter is present, the filter gets a list of blacklists for this instance filtering by lang.
Security
The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN, SEARCH_MANAGER or SEARCH_ANALYST role for this instance or the global instance.
Parameters
...
Response format and codes
...
HTTP code
...
Description
...
language | xml |
---|---|
theme | Confluence |
title | Response |
blacklist items for the client {instance_id}. The result list is paginated.
URI Parameters
Parameter Name | Required | Description |
---|---|---|
rows | See: Empathy Play API - Pagination | |
offset | See: Empathy Play API - Pagination | |
enabled | Filter by enabled/disabled state | |
lang | Filter by boost language | |
keywords | Filter by boost keywords |
Responses
200 - successful information retrieve
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{
"num_found": 3,
"results": [
{
"created_on": "2017-02-24T10:19:27",
"id": "58b008b0f9cdda056a241e49",
"lang": "en_EN",
"terms": "prueba 1 mod",
"updated_on": "2017-02-24T10:20:23"
},
{
"created_on": "2017-02-24T10:23:13",
"id": "58b00991f9cdda056b78a7eb",
"lang": "en_EN",
"terms": "prueba 2",
"updated_on": "2017-02-24T10:23:13"
},
{
"created_on": "2017-02-24T10:23:23",
"id": "58b0099bf9cdda056a241e4a",
"lang": "es_ES",
"terms": "prueba 1",
"updated_on": "2017-02-24T10:23:23"
}
]
} |
400 - Invalid parameters. Error response will include details
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 Block | ||||
---|---|---|---|---|
| ||||
{ "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" } |
404 - the instance doesn't exist or offset is wrong
Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ "code": 404, "details": "", "message": "Not Found", "status": "error" } |