templatedashboard.create

説明

object templatedashboard.create(object/array templateDashboards)

このメソッドでは、新しいテンプレートダッシュボードを作成できます。

パラメータ

(object/array) 作成するテンプレートダッシュボード。

このメソッドは、標準のテンプレートダッシュボード プロパティに加えて、以下の パラメータを受け付けます。

戻り値

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

例

テンプレートダッシュボードの作成

単一のダッシュボードページに1つのグラフウィジェットを配置した、“Graphs” という名前のテンプレートダッシュボードを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.create",
    "params": {
        "templateid": "10318",
        "name": "Graphs",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graph",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 6,
                                "name": "graphid",
                                "value": "1123"
                            }
                        ]
                    }
                ]

            }
        ]
    },
    "id": 1
}

レスポンス:

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

関連項目

• テンプレートダッシュボードページ
• テンプレートダッシュボードウィジェット
• テンプレートダッシュボードウィジェット フィールド

ソース

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