curl -X POST '{backend_url}/admin/views/{entity}/configurations/{id}' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
-d '{
"is_system_default": true
}'{
"view_configuration": {
"id": "<string>",
"entity": "<string>",
"name": "<string>",
"user_id": "<string>",
"is_system_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"configuration": {
"visible_columns": [
"<string>"
],
"column_order": [
"<string>"
],
"column_widths": {},
"filters": {},
"sorting": {
"id": "<string>",
"desc": true
},
"search": "<string>"
}
}
}Update View Configuration
Update the view configuration of an entity. An admin user can only update their own configurations.
curl -X POST '{backend_url}/admin/views/{entity}/configurations/{id}' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
-d '{
"is_system_default": true
}'{
"view_configuration": {
"id": "<string>",
"entity": "<string>",
"name": "<string>",
"user_id": "<string>",
"is_system_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"configuration": {
"visible_columns": [
"<string>"
],
"column_order": [
"<string>"
],
"column_widths": {},
"filters": {},
"sorting": {
"id": "<string>",
"desc": true
},
"search": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The entity to update its view configuration (for example, orders).
The view configuration's ID.
Body
The details to update in a view configuration.
Whether the view is set as active.
The view's name.
Whether the view is the system default.
The view's configuration.
Show child attributes
Show child attributes
The search query used in the view.
The configuration's visible columns.
The visible column's name.
The columns in the order they should be displayed.
The column's name.
The column widths in the view.
The filters applied to the view.
Response
OK
The details of a view configuration.
The details of a view configuration.
Show child attributes
Show child attributes
The view configuration's ID.
The entity the view configuration belongs to.
The view configuration's name.
The ID of the user the view configuration belongs to. If null, the view configuration is a system default.
Whether the view configuration is the system default.
The date the view configuration was created.
The date the view configuration was updated.
The view's configuration.
Show child attributes
Show child attributes
The configuration's visible columns.
The visible column's name.
The columns in the order they should be displayed.
The column's name.
The column widths in the view.
The filters applied to the view.
The configuration's search.