templatedashboard.create
説明
object templatedashboard.create(object/array templateDashboards)
このメソッドは新しいテンプレートダッシュボードを作成します。
このメソッドは管理者およびスーパ管理者ユーザータイプでのみ利用可能です。メソッドを呼び出す権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメーター
(object/array) 作成するテンプレートダッシュボード。
標準のテンプレートダッシュボードプロパティに加えて、このメソッドは以下のパラメーターを受け付けます。
| パラメーター | タイプ | 説明 |
|---|---|---|
| pages | array | ダッシュボードに作成するテンプレートダッシュボードページ。ダッシュボードページは指定された順序で並べられます。 パラメータの動作: - 必須 |
戻り値
(object) dashboardids プロパティの下に作成されたテンプレート ダッシュボードの ID を含むオブジェクトを返します。 返される ID の順序は、渡されたテンプレート ダッシュボードの順序と一致します。
例
テンプレートダッシュボードの作成
1つのダッシュボードページに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.