NEnetxms
Objects

Replace dashboard content

Changed on

Replace the content of a dashboard or dashboard template object. The elements array, when present, fully replaces the element (widget) layout; an element without a guid is assigned a new one. Only dashboard content fields are applied — other object properties are left untouched. displayPriority and forcedContextObjectId apply to plain dashboards only and are ignored for dashboard templates. Requires modify access and applies only to objects of class Dashboard or DashboardTemplate.

put/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

Request body

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).

Response

Dashboard content updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

  • 53fbfac7f424Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2827204d68d9Revision changes
    • warning

      added the new Room enum value to the response property for the response status