識別子IDインポート¶
POST /api/v1/board/import/identifier
概要¶
識別子IDに基づいてグローバルにインポートします。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| importType | array | Y | インポート範囲。dashboard-ダッシュボード；userViewer-ユーザービュー；innerViewerZh-中国語組み込みビュー；innerViewerEn-英語組み込みビュー 空文字許可: False |
| identifier | string | Y | 識別子ID 空文字許可: False |
| templateInfo | json | ダッシュボードテンプレートデータ 例: {} 空文字許可: False 空文字列許可: False |
パラメータ補足説明¶
パラメータ説明:
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| importType | array[string] | 必須 | インポート範囲。dashboard-ダッシュボード；userViewer-ユーザービュー；innerViewerZh-中国語組み込みビュー；innerViewerEn-英語組み込みビュー |
| identifier | string | 識別子ID | |
| templateInfo | json | ダッシュボードテンプレートデータ |
templateInfoの主な構造の説明
以下のフィールドを指定すると、すべての識別子IDが一致するオブジェクトの対応するフィールドが置き換えられます。指定しない場合は置き換えは行われず、元のオブジェクトの属性値が使用されます。
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| title | string | ビューのタイトル名。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトの属性が置き換えられることに注意してください。 | |
| summary | string | テンプレートの概要情報。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトの属性が置き換えられることに注意してください。 | |
| identifier | string | テンプレート識別子ID。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトのタイトルが置き換えられることに注意してください。 | |
| dashboardExtend | json | ビューの追加データ情報 | |
| dashboardMapping | array[json] | ビュー変数のフィールドマッピング設定リスト | |
| iconSet | json | ダッシュボードのアイコン情報。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトのタイトルが置き換えられることに注意してください。 | |
| iconSet.url | json | ダッシュボードの中型アイコンのリンクURL | |
| iconSet.icon | json | ダッシュボードの小型アイコンのリンクURL | |
| icon | string | ダッシュボードの小型アイコンファイル名。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトのタイトルが置き換えられることに注意してください。 | |
| thumbnail | string | ダッシュボードの中型アイコンファイル名。このフィールドを指定すると、すべての識別子IDが一致するオブジェクトのタイトルが置き換えられることに注意してください。 | |
| main | json | ダッシュボードの内容構造 | |
| main.type | string | テンプレートタイプ。このフィールドはシステムフィールドであり、無視して構いません。 | |
| main.vars | array[json] | ビュー変数設定リスト | |
| main.vars[#] | json | ビュー変数設定構造 | |
| main.groups | array[string] | チャートグループ名リスト | |
| main.charts | array[json] | ビューのチャート設定リスト | |
| main.charts[#] | json | チャート設定構造 |
dashboardMapping[#]の主な構造の説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
main.charts[#]の主な構造の説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | string | 必須 | チャート名 |
| type | string | 必須 | チャートタイプ |
| pos | json | チャートの位置構造 | |
| pos.i | string | ||
| pos.h | string | 高さ | |
| pos.w | string | 幅 | |
| pos.x | string | X軸座標 | |
| pos.y | string | Y軸座標 | |
| group | json[string] | グループ情報 | |
| group.name | string | グループ名。グループがない場合はnullを許可 | |
| queries | array[json] | 必須 | チャートクエリ文の構造リスト |
時系列チャート 構造 main.charts[#].type=sequence の主な構造パラメータは次のとおりです:
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | string | 必須 | チャート名 |
| type | string | 必須 | チャートタイプ |
| pos | string | 必須 | チャートタイプ |
| queries | array[json] | 必須 | チャートクエリ文の構造リスト |