Deskhero Developer Hub
Back to deskhero.com
View states

Save sort only

Writes just the sort field and direction onto the named view state, leaving its columns, filters, pagination and kanban settings untouched. It never creates: a name that has no stored state in the scope fails, as does a sort key the entity does not have (unlike the full save, which quietly substitutes one), and the response echoes what was submitted rather than the stored state.

PUT /api/{tenant:minlength(2)}/v{version:apiVersion}/view_states/save_sort_only
Authorisation
Minimum role: USER

Request arguments

Name Type Source
entityENUM entity
optional_idInt32
nameString
payloadDTO_view_state_sortBody
Request body example

Response

Status
200 (OK)
Type
DTO_view_state_sort[]
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_view_state_sort
NameTypeReadOnlyDescription
field_keyStringField key
orderENUM sort_orderOrder
ENUM sort_order
ValueNameDescription
0ASCASC
1DESCDESC

Generated Aug 4, 2026 18:37