エクスポート¶
GET /api/v1/viewer/{viewer_uuid}/export
概要¶
指定したエクスプローラーを JSON テンプレートとしてエクスポートします。
呼び出し前の準備と使用手順¶
エクスプローラー一覧から UUID を取得します。レスポンスの content を保存し、エクスプローラーの作成またはインポートに使用します。エクスポート時には、デフォルトのクエリ空間とターゲットサイト設定が削除されます。外部データソースの名前または識別子は、ターゲットワークスペースに合わせて再バインドが必要になる場合があります。テンプレートの内容は、チャート、変数、グループの構造を維持します。
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| viewer_uuid | string | Y | 現在のワークスペースにおける対象エクスプローラーの UUID。 例: dsbd_view_example取得または入力方法: エクスプローラー一覧の content.data[].uuid から取得します。作成レスポンスの content.uuid を使用することもできます。 |
リクエストヘッダー¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| title | string | 任意。エクスポートするタイトルを上書きします。 例: ホストインスペクションテンプレート取得または入力方法: エクスポートテンプレートにのみ使用するタイトルを入力します。 |
パラメータ補足説明¶
成功レスポンスの content はポータブルなテンプレートデータです。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/export' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | タイプ | 説明 |
|---|---|---|
| content.title | string | テンプレート名。title Query を使用するとエクスポート結果のみを上書きできます。 |
| content.summary | string | テンプレートの説明。 |
| content.identifier | string | カスタム識別子。 |
| content.dashboardType | string | 保存されたエクスプローラーのタイプ。 |
| content.dashboardOwnerType | string | ソースビューリソースの所属。 |
| content.dashboardExtend | object | ポータブルな拡張設定。 |
| content.dashboardMapping | array<object> |
変数フィールドのマッピング。 |
| content.dashboardBindSet | array | ビューのバインド設定。 |
| content.iconSet | object | アイコン設定。 |
| content.thumbnail | string | サムネイルフィールド。 |
| content.tagInfo | array<object> |
テンプレートに関連付けられたタグ。 |
| content.tagInfo[].name | string | テンプレートタグ名。 |
| content.main | object | テンプレート内のチャート、変数、グループ。 |
| content.main.type | string | 固定値 template。 |
| content.main.vars | array<object> |
変数定義の配列。 |
| content.main.vars[].name | string | 変数名。 |
| content.main.vars[].type | string | 変数タイプ。 |
| content.main.vars[].definition | object | 変数定義。内容はタイプによって変わります。 |
| content.main.vars[].seq | integer | 変数の順序。 |
| content.main.vars[].code | string | 変数のコード。変数の参照に使用します。 |
| content.main.vars[].datasource | string | 変数のデータソース。 |
| content.main.vars[].valueSort | string | 変数値の並び替え方式。 |
| content.main.vars[].hide | integer | 変数を非表示にする設定。 |
| content.main.vars[].isHiddenAsterisk | integer | 非表示アスタリスクオプションの設定。 |
| content.main.vars[].multiple | boolean | 複数選択を許可するか。 |
| content.main.vars[].includeStar | boolean | アスタリスクオプションを含めるか。 |
| content.main.vars[].extend | object | 変数の拡張設定。 |
| content.main.charts | array<object> |
チャート定義の配列。インポート時にチャート UUID が再作成されます。 |
| content.main.charts[].uuid | string | ソースチャート UUID。 |
| content.main.charts[].name | string | チャート名。 |
| content.main.charts[].type | string | チャートタイプ。 |
| content.main.charts[].chartGroupUUID | string | ソースチャートグループ UUID。 |
| content.main.charts[].group.name | string または null | チャートグループ名。 |
| content.main.charts[].prevGroupName | string または null | 以前のチャートグループ名。 |
| content.main.charts[].pos | object | レイアウト内のチャートの位置とサイズ。 |
| content.main.charts[].queries | array<object> |
チャートのクエリ設定。 |
| content.main.charts[].extend | object | チャートの表示とインタラクション設定。 |
| content.main.groups | array<object> |
グループ定義の配列。 |
| content.main.groups[].name | string | チャートグループ名。 |
| content.main.groups[].extend | object | チャートグループの拡張設定。 |
| content.main.chartGroupPos | array<string> |
チャートグループの並び順識別子。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"title": "主机巡检查看器",
"summary": "主机巡检与状态核对",
"identifier": "",
"dashboardType": "CUSTOM",
"dashboardExtend": {},
"dashboardMapping": [],
"dashboardBindSet": [],
"iconSet": {},
"main": {
"type": "template",
"charts": [],
"vars": [],
"groups": [],
"chartGroupPos": []
},
"dashboardOwnerType": "viewer",
"thumbnail": "",
"tagInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
対象が存在しない場合でも、成功として空のオブジェクトが返る可能性があります。title を指定した場合も、テンプレートタイトルと共通フィールドのみが返る可能性があります。保存およびインポートする前に、main が返されているか確認してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.InvalidParameter | 過去のチャートクエリ構造が無効で、有効なテンプレートとしてエクスポートできない | パラメータ{}が無効 |
エラー内のフィールドパスに従って元のビューのチャート設定を確認し、修正後に再エクスポートしてください。 |