StaffWidgetsBoard

Entity description

A staff widgets board is a layout structure that organizes dashboard widgets into sections. Each board is defined by a layout type, sections, and associated widgets, allowing customizable dashboard configurations.

Properties

Name	Description	Type	Example
uid	Unique identifier of the staffWidgetsBoard object	string	`d290f1ee-6c54-4b01-90e6-d701748f0851`
board_layout_code_name	A string representing the board layout	string	`MainAndSideBar2Columns`
type	The grid frame of the layout, determines the layout frame containing the board	string	`home`
sections	An array of dashboard sections. Each section contains properties defining it and a list of widgets.	array	See Sections table below
created_at	The time the staffWidgetsBoard was created	string	`2021-06-20T14:00:00.000Z`
updated_at	The time the staffWidgetsBoard was last updated	string	`2021-07-15T14:00:00.000Z`

Sections Properties

Name	Description	Type	Example
code_name	A code name representing the type of the section	string	`Main`
widgets	An array of widget UIDs populated in the section	array	See Example for detailed widget structure

Example

{
  "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "board_layout_code_name": "MainAndSideBar2Columns",
  "type": "home",
  "sections": [
    {
      "code_name": "Main",
      "widgets": [
        {
          "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "app_code_name": "myappcode",
          "display_name": {
            "en": "Payments",
            "fr": "Paiements"
          },
          "dimensions": {
            "max_height": 2,
            "min_height": 1,
            "height": 2,
            "max_width": 3,
            "min_width": 1,
            "width": 2
          },
          "component_data": {
            "name": "iFrame",
            "config": {
              "title": "calendar",
              "url": "www.partnerdomain.com/calendar"
            }
          }
        },
        {
          "uid": "d290f1ee-6c54-4b01-90e6-d701748f03434",
          "app_code_name": "myappcode2",
          "display_name": {
            "en": "Clients",
            "fr": "Clientèle"
          },
          "dimensions": {
            "max_height": 3,
            "min_height": 2,
            "height": 3,
            "max_width": 4,
            "min_width": 1,
            "width": 3
          },
          "component_data": {
            "name": "iFrame",
            "config": {
              "title": "clients",
              "url": "www.partnerdomain.com/clients"
            }
          }
        }
      ]
    }
  ],
  "created_at": "2021-06-20T14:00:00.000Z",
  "updated_at": "2021-07-15T14:00:00.000Z"
}