This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.

templatedashboard.get

Description

integer/array templatedashboard.get(object parameters)

The method allows to retrieve template dashboards according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
dashboardids string/array Return only template dashboards with the given IDs.
templateids string/arary Return only template dashboards that belong to the given templates.
selectWidgets query Return a widgets property containing template dashboard widgets.
sortfield string/array Sort the result by the given properties.

Possible values are: dashboardid and name.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieving template dashboards

Retrieve all template dashboards with widgets for a specified template.

Request:

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.get",
           "params": {
               "output": "extend",
               "selectWidgets": "extend",
               "templateids": "10001"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dashboardid": "23",
                   "name": "Docker overview",
                   "templateid": "10001",
                   "widgets": [
                       {
                           "widgetid": "220",
                           "type": "graph",
                           "name": "",
                           "x": "0",
                           "y": "0",
                           "width": "12",
                           "height": "5",
                           "view_mode": "0",
                           "fields": [
                               {
                                   "type": "6",
                                   "name": "graphid",
                                   "value": "1125"
                               }
                           ]
                       },
                       {
                           "widgetid": "221",
                           "type": "graph",
                           "name": "",
                           "x": "12",
                           "y": "0",
                           "width": "12",
                           "height": "5",
                           "view_mode": "0",
                           "fields": [
                               {
                                   "type": "6",
                                   "name": "graphid",
                                   "value": "1129"
                               }
                           ]
                       },
                       {
                           "widgetid": "222",
                           "type": "graph",
                           "name": "",
                           "x": "0",
                           "y": "5",
                           "width": "12",
                           "height": "5",
                           "view_mode": "0",
                           "fields": [
                               {
                                   "type": "6",
                                   "name": "graphid",
                                   "value": "1128"
                               }
                           ]
                       },
                       {
                           "widgetid": "223",
                           "type": "graph",
                           "name": "",
                           "x": "12",
                           "y": "5",
                           "width": "12",
                           "height": "5",
                           "view_mode": "0",
                           "fields": [
                               {
                                   "type": "6",
                                   "name": "graphid",
                                   "value": "1126"
                               }
                           ]
                       },
                       {
                           "widgetid": "224",
                           "type": "graph",
                           "name": "",
                           "x": "0",
                           "y": "10",
                           "width": "12",
                           "height": "5",
                           "view_mode": "0",
                           "fields": [
                               {
                                   "type": "6",
                                   "name": "graphid",
                                   "value": "1127"
                               }
                           ]
                       }
                   ]
               }
           ],
           "id": 1
       }

Source

CTemplateDashboard::get() in ui/include/classes/api/services/CTemplateDashboard.php.