NEnetxms
Objects

Get dashboard content

Changed on

Return the content of a dashboard or dashboard template object: the column count, the scrollable flag, display priority, and the element (widget) layout. Requires read access. Applies only to objects of class Dashboard or DashboardTemplate.

get/v1/objects/{object-id}/dashboard

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/dashboard
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Response

Dashboard content.

numColumnsinteger

Number of layout columns.

scrollableboolean

When true the dashboard scrolls vertically and elements keep their own heights. When false (the default) the elements are fitted to the available height, with rows carrying grabVerticalSpace sharing whatever space is left over.

displayPriorityinteger

Display ordering priority (plain dashboards only; ignored for templates).

forcedContextObjectIdinteger

Forced context object ID for dashboards created from a template (plain dashboards only; ignored for templates).

Changes