dashboard.create

説明

object dashboard.create(object/array dashboards)

このメソッドは、新しいダッシュボードを作成することができます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(object/array) 作成するダッシュボード。

dashboardの標準プロパティに加えて、このメソッドは以下のパラメーターを受け付けます。

パラメーター タイプ 説明
pages array ダッシュボード用に作成されるダッシュボードページ。ダッシュボードページは、指定された順序と同じ順序で並べられます。

パラメーターの動作:
- 必須
users array ダッシュボードユーザー共有はダッシュボード上に作成されます。
userGroups array ダッシュボードユーザーグループ共有はダッシュボード上に作成されます。

戻り値

(object) dashboardidsプロパティの下に作成されたダッシュボードのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたダッシュボードの順序と一致します。

例

ダッシュボードの作成

単一のダッシュボードページで、タグ付きの障害ウィジェットと2種類の共有(ユーザーグループとユーザー)を持つ、"My dashboard"という名前のダッシュボードを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "problems",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "service"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "zabbix_server"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "2"
        ]
    },
    "id": 1
}

参照

ソース

CDashboard::create() in ui/include/classes/api/services/CDashboard.php.