Filter
API for Filter object
Method & Permission
API | GET | POST | PUT | PATCH | DELETE |
Filter List | Admin, Member* | Admin, Member | - | - | - |
Filter Detail | Admin, Member* | - | - | Admin, Member* | Admin, Member* |
*Member can only view/edit the filters belong to the members
Filter List
GET
{{ base_url }} /tables/filter/list/{level}/{sid}/{serializer}/
Path Parameters
Name | Type | Description |
---|---|---|
level | string | organization |
sid | string | organization sid |
serializer | string |
Query Parameters
Name | Type | Description |
---|---|---|
table__sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Filter List
POST
{{ base_url }} /tables/filter/list/{level}/{sid}/{serializer}/
Path Parameters
Name | Type | Description |
---|---|---|
level | string | organization |
sid | string | organization sid |
serializer | string |
Query Parameters
Name | Type | Description |
---|---|---|
table__sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
description | string | |
is_archived | boolean | |
users | array | |
query | object | {field__expr: value} |
Filter Detail
GET
{{ base_url }} /tables/filter/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Filter Detail
PATCH
{{ base_url }} /tables/filter/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
description | string | |
is_archived | string | |
users | string | |
query | string | Please note this is different to POST |
Filter Detail
DELETE
{{ base_url }} /tables/filter/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Last updated