Filter
YW
Last updated 4 months ago
API for Filter object
getFilter List
{{ base_url }}
/tables/filter/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
200: OK
{"page_size": 10,"page_number": 1,"page_count": 1,"count": 10,"next": null,"previous": null,"add_permission": true,"results": [{"sid": "xxx","name": "xxx","description": null,"query": "name__icontains=2___[{\"field\": \"name\", \"expr\": \"icontains\", \"value\": \"2\"}]","users": [],"is_archived": false,"change_permission": true},...]}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correctWrong level - the provided level is not acceptable
postFilter List
{{ base_url }}
/tables/filter/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
required
string
​
description
optional
string
​
is_archived
optional
boolean
​
users
optional
array
​
query
required
object
{field__expr: value}
200: OK
{"sid": "xxx","name": "xxx","description": null,"query": "name__icontains=2___[{\"field\": \"name\", \"expr\": \"icontains\", \"value\": \"2\"}]","users": [],"is_archived": false,"date_updated": "2018-05-17T22:41:46.342929Z","date_created": "2017-10-19T02:41:07.473081Z","change_permission": true}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correctWrong level - the provided level is not acceptable
getFilter Detail
{{ base_url }}
/tables/filter/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
200: OK
{"sid": "xxx","name": "xxx","description": null,"query": "name__icontains=2___[{\"field\": \"name\", \"expr\": \"icontains\", \"value\": \"2\"}]","users": [],"is_archived": false,"date_updated": "2018-05-17T22:41:46.342929Z","date_created": "2017-10-19T02:41:07.473081Z","change_permission": true}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
patchFilter Detail
{{ base_url }}
/tables/filter/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
optional
string
​
description
optional
string
​
is_archived
optional
string
​
users
optional
string
​
query
optional
string
Please note this is different to POST
200: OK
{"sid": "xxx","name": "xxx","description": null,"query": "name__icontains=2___[{\"field\": \"name\", \"expr\": \"icontains\", \"value\": \"2\"}]","users": [],"is_archived": false,"date_updated": "2018-05-17T22:41:46.342929Z","date_created": "2017-10-19T02:41:07.473081Z","change_permission": true}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
deleteFilter Detail
{{ base_url }}
/tables/filter/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
204: No Content
{}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct