curl -X POST '{backend_url}/admin/views/{entity}/configurations' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
-d '{
"is_system_default": true,
"name": "Custom View"
}'{
"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>"
}
}
}Create View Configuration
Create a new view configuration for an entity. If is_system_default is set to true, the created configuration will be set as the system default for the specified entity. Otherwise, it will be a custom configuration for the admin user.
curl -X POST '{backend_url}/admin/views/{entity}/configurations' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
-d '{
"is_system_default": true,
"name": "Custom View"
}'{
"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 create its view configuration (for example, orders).
Body
The details of a view configuration to create.
Whether the view is the system default. If so, it will be used as the default view for all users that don't have a custom active view set.
Whether the view is set as active.
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 search query used in the view.
The column widths in the view.
The filters applied to the view.
The view's name.
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.