Preferences
Preferences store per-user Admin UI configuration for a named resource (users, socials or auditLogs; locked templates are seeded for users and socials). The list for a resource merges locked system templates (locked: true) with the authenticated user's own rows (locked: false).
Paths below use Megadex's internal /megadex/… mount. A BFF typically exposes the same routes publicly under /api/megadex/….
List Preferences
Returns all locked system templates plus the authenticated user's personal preferences for :resource, ordered by name. Exactly one item has isActive: true (the user's selected preference in preference_selection, or the "Default" template if none is selected).
GET /megadex/preferences/users
Authorization: Bearer <access_token>Response (200 OK):
{
"rows": [
{
"id": 1,
"resourceName": "users",
"name": "Default",
"conf": [
{ "key": "id", "isVisible": false },
{ "key": "civility", "isVisible": true, "defaultWidth": "60px" },
{ "key": "firstName", "isVisible": true }
],
"locked": true,
"isActive": true
},
{
"id": 8,
"resourceName": "users",
"name": "Active Engineers",
"conf": [
{ "key": "id", "isVisible": false },
{ "key": "nickname", "isVisible": true },
{ "key": "email", "isVisible": true }
],
"locked": false,
"isActive": false
}
]
}Create Preferences
Creates a new personal preference for the caller on :resource. If isActive: true, it also becomes the caller's active selection in preference_selection. Each user may create up to 10 personal preferences per resource (check_preference_limit), and personal preferences cannot reuse the name of a locked template (check_preference_template_name).
POST /megadex/preferences/socials
Content-Type: application/json
Authorization: Bearer <access_token>
{
"rows": [
{
"name": "Compact Socials",
"isActive": true,
"conf": [
{ "key": "name", "isVisible": true, "defaultWidth": "200px" },
{ "key": "url", "isVisible": true }
]
}
]
}name, conf and isActive are required on POST. conf is a JSON array of column descriptors (key, isVisible and an optional defaultWidth).
Update or Select Preferences
Updates personal preferences or selects a template:
- Selecting a locked template: Sending a template's
idwithisActive: trueand its unchangednameandconfupdatespreference_selectionfor the caller without modifying the template. - Editing a locked template (fork-on-write): Sending a template's
idwith a modifiednameorconfleaves the locked template untouched and inserts a new personal preference row for the caller. - Updating a personal preference: Updates
name,conf, and/orisActiveon the caller's own row. The batch is rejected with 403 if any row belongs to another user or falls outside the resource, and with 400 ifrowsis missing or a row has no valid integerid.nameandisActiveare required onPUT.
PUT /megadex/preferences/socials
Content-Type: application/json
Authorization: Bearer <access_token>
{
"rows": [
{
"id": 7,
"name": "Default",
"isActive": true,
"conf": [
{ "key": "id", "isVisible": false },
{ "key": "name", "isVisible": true },
{ "key": "url", "isVisible": true }
]
}
]
}Delete Preference
Deletes a single preference owned by the authenticated user. Locked system templates and preferences belonging to other users cannot be deleted (404).
DELETE /megadex/preferences/socials/:id
Authorization: Bearer <access_token>Response (200 OK): { "rows": […], "total": … }, as for the other endpoints.
Get Entity Schema
GET /megadex/preferences/schema
Authorization: Bearer <access_token>