コンテンツにスキップ

エクスポート


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

概要

notes_uuid で指定されたノートをテンプレート構造としてエクスポートします。

ルートパラメータ

パラメータ名 タイプ 必須 説明
notes_uuid string Y ノート UUID

パラメータ補足説明

ノートテンプレート構造の説明:

テンプレートの基本構造は、ビュー構造（グラフ構造のみ）で構成されます。

templateInfo の主要構造説明

パラメータ名 type 必須 説明
name string 必須 ノートタイトル
main json エクスポート内容の本体構造
main.charts array グラフテンプレート構造のリスト
main.charts[#] json グラフテンプレート構造

main.charts[#] の構造説明

パラメータ名 type 必須 説明
name string 必須 グラフ名
type string 必須 グラフタイプ
queries array[json] 必須 グラフクエリ文構造のリスト

時系列グラフ 構造 type=sequence の主要構造パラメータ

パラメータ名 type 必須 説明
name string 必須 グラフ名
type string 必須 グラフタイプ
queries array[json] 必須 グラフクエリ文構造のリスト

リクエスト例

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

レスポンス

{
    "code": 200,
    "content": {
        "main": {
            "charts": [
                {
                    "extend": {},
                    "name": "",
                    "queries": [
                        {
                            "query": {
                                "content": "Note Content"
                            }
                        }
                    ],
                    "type": "text"
                }
            ]
        },
        "name": "My Notes"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-8FD9876D-842E-4E0D-AC9E-F76E98943984"
}

フィードバック

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