Dashboard - ClarusWMS

{
  "code": "warehouse-ops",
  "name": "Warehouse Operations",
  "description": "Day-to-day operational view",
  "is_active": true,
  "is_default": true,
  "role_ids": [
    1,
    4
  ]
}

Dashboard attributes. Dashboards group widget placements and are visible to users assigned to one of the associated roles. role_ids is supplied inside attributes (not in a separate relationships object) and replaces the dashboard's existing role associations. Widget placements are managed separately through the PUT /api/dashboards/{id}/widgets endpoint.

code

string

required

Unique dashboard code

Maximum string length: 30

name

string

required

Display name

Maximum string length: 50

description

string | null

Optional dashboard description

Maximum string length: 255

is_active

boolean

Whether the dashboard is visible to users. Defaults to true on create.

is_default

boolean

When true, this dashboard becomes the default for users. Setting true clears is_default on every other dashboard in the same transaction. Defaults to false on create.

role_ids

integer[]

Role IDs that can access this dashboard. On update, the supplied list replaces all existing role associations.

⌘I