This is a translation of the original English documentation page. Help us make it better.

templatedashboard.create

説明

object templatedashboard.create(object/array templateDashboards)

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

このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。

パラメータ

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

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

パラメータ タイプ 説明
pages
(必須)
array ダッシュボード用に作成されるテンプレート ダッシュボード ページ。ダッシュボード ページは指定した順序で並べられます。 pages プロパティには少なくとも 1 つのダッシュボード ページ オブジェクトが必要です。

戻り値

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

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

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

Request:

{
           "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"
                                   }
                               ]
                           }
                       ]
                       
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

参照

ソース

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