Sign in
Objects

Replace dashboard content

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

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

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

Changes

Changed in 10 of the 115 revisions of this API.456

  • 2827204d68d91See the full diff
    • ●

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

      response-property-enum-value-added

  • ef2ed4fdc37611See the full diff
    • ▲

      response property customAttributes/items/value list-of-types was widened by adding types array and object to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 93009b99863911See the full diff
    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 15170fcce6771See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fd66f32833f11See the full diff
    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c4fbee63f8433See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 33e22ed0a8a51See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 04731b73e7231See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • aceb7017168f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • c6aaf3632e481See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog