4 Discovery status

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Discovery status widget in dashboard.create and dashboard.update methods.

Parameters

The following parameters are supported for the Discovery status widget.

Parametertypenamevalue
Refresh interval0rf_rate0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Discovery status widget. For more information on configuring a dashboard, see dashboard.create.

Configuring Discovery status widget

Configure a Discovery status widget with the refresh interval set to 15 minutes.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.create",
  4.            "params": {
  5.                "name": "My dashboard",
  6.                "display_period": 30,
  7.                "auto_start": 1,
  8.                "pages": [
  9.                    {
  10.                        "widgets": [
  11.                            {
  12.                                "type": "discovery",
  13.                                "name": "Discovery status",
  14.                                "x": 0,
  15.                                "y": 0,
  16.                                "width": 6,
  17.                                "height": 3,
  18.                                "view_mode": 0,
  19.                                "fields": [
  20.                                    {
  21.                                        "type": 0,
  22.                                        "name": "rf_rate",
  23.                                        "value": 900
  24.                                    }
  25.                                ]
  26.                            }
  27.                        ]
  28.                    }
  29.                ],
  30.                "userGroups": [
  31.                    {
  32.                        "usrgrpid": 7,
  33.                        "permission": 2
  34.                    }
  35.                ],
  36.                "users": [
  37.                    {
  38.                        "userid": 1,
  39.                        "permission": 3
  40.                    }
  41.                ]
  42.            },
  43.            "id": 1
  44.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "3"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

See also