View states / List
Returns fields that can be used in filters.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/view_states
Method: GET
Authorisation: Minimum role: USER
Request Arguments
| Name |
Type |
Source |
| entity | ENUM entity | |
| optional_id | Int32 | |
Request body example
Response object
Response status: 200 (OK)
Response type:
DTO_view_state[]
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_view_state_field_info
DTO_view_state_field_filter
| Name | Type | ReadOnly | Description |
|---|
| allow | Boolean | | Allow |
| type | ENUM filter_type | | Type |
| usage_count | Int32 | | Usage count |
DTO_view_state_field_group
| Name | Type | ReadOnly | Description |
|---|
| allow | Boolean | | Allow |
DTO_view_state_field_batch
| Name | Type | ReadOnly | Description |
|---|
| allow | Boolean | | Allow |
DTO_view_state_field_sort
| Name | Type | ReadOnly | Description |
|---|
| allow | Boolean | | Allow |
DTO_view_state_field_setting
DTO_view_state_field_column
| Name | Type | ReadOnly | Description |
|---|
| width | Int32 | | Width |
| visible | Boolean | | Visible |
| order | Int32 | | Order |
DTO_view_state_field_row
| Name | Type | ReadOnly | Description |
|---|
| upper_order | Int32 | | Upper order |
| lower_order | Int32 | | Lower order |
DTO_view_state_field_kanban
| Name | Type | ReadOnly | Description |
|---|
| card_position | Int32 | | Card position |
| hover_order | Int32 | | Hover order |
DTO_view_state_sort
| Name | Type | ReadOnly | Description |
|---|
| field_key | String | | Field key |
| order | ENUM sort_order | | Order |
| Name | Type | ReadOnly | Description |
|---|
| take | Int32 | | Take |
DTO_view_state_kanban
| Name | Type | ReadOnly | Description |
|---|
| swimlane_key | String | | Swimlane key |
| swimlane_order | String[] | | Swimlane order |
| column_key | String | | Column key |
| column_order | String[] | | Column order |
ENUM field_data_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | STRING | Text |
| 2 | MULTI_LINE_STRING | Text (multi-line) |
| 3 | DATE_TIME | Date and time |
| 4 | DATE_NO_TIME | Date |
| 5 | DOUBLE | Number (decimal) |
| 6 | INT | Number (int) |
| 7 | LONG | Number (long) |
| 8 | BOOL | On / Off |
| 9 | EMAIL | Text (email) |
| 10 | PHONE | Text (phone) |
| 11 | PICK_ONE | Pick one |
| 12 | PICK_MANY | Pick many |
| 13 | IMAGE | Image |
| 14 | RICH_TEXT | Text (rich editor) |
| 15 | FILES | Files |
| 16 | COLOR | Color |
| -1 | INTERNAL_ENUM | INTERNAL_ENUM |
ENUM filter_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | DEFAULT | Default |
| 2 | RANGE | Range |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM view_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | LIST | List |
| 2 | KANBAN | Kanban |
