コンテンツにスキップ

エクスポート



GET /api/v1/notes/{notes_uuid}/export

概要

旧版ノートを1件とそのチャート定義をエクスポートし、後続のインポートに使用します。

呼び出し前の準備と使用手順

ノート一覧からノート UUID を取得します。レスポンスの content をテンプレートとして保持します。対象ワークスペースで空のノートを作成した後、ノートのインポートでそのテンプレートを適用できます。エクスポート名だけを変更する場合は、name を指定できます。

ルートパラメータ

パラメータ名 型 必須 説明
notes_uuid string Y 対象の旧版ノートの UUID。
例: note_example
取得または入力方法: ノート一覧の content.data[].uuid から取得します。作成レスポンスの content.uuid も使用できます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
name string 任意。エクスポート内容の name を置き換えます。ソースノートには保存されません。
例: 巡检模板
取得または入力方法: テンプレートで使用する名前を入力し、通常の Query として URL エンコードします。

パラメータ補足説明

テンプレート JSON を返します。content を保存すると、後続の templateInfo として使用できます。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/notes/note_example/export' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content.name string テンプレート内のノート名。
content.extend object ノートの拡張設定。
content.main object ノート内容の定義。
content.main.charts array<object> ノートに保存された順序でエクスポートされたチャート定義。
content.main.charts[].name string エクスポートされたチャート名。
content.main.charts[].type string エクスポートされたチャートタイプ。
content.main.charts[].queries array<object> チャートのクエリまたは内容定義。
content.main.charts[].extend object チャートの拡張設定。
content.declaration object または null ワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "name": "生产巡检笔记",
    "extend": {},
    "main": {
      "charts": [
        {
          "name": "巡检说明",
          "type": "text",
          "queries": [
            {
              "query": {
                "content": "按仪表板核对生产状态。"
              }
            }
          ],
          "extend": {}
        }
      ]
    },
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。

対象が存在しない場合、または現在のワークスペースに属していない場合は、成功と空のオブジェクトが返されることがあります。name を指定した場合も、テンプレート名と宣言だけが返されることがあります。テンプレートを使用する前に、main.charts が返されていることを確認してください。

フィードバック

このページは役に立ちましたか?