Export¶

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

Overview¶

Export the note specified by notes_uuid as a template structure.

Route Parameters¶

Parameter Name	Type	Required	Description
notes_uuid	string	Y	Note UUID

Supplementary Parameter Explanation¶

Note template structure explanation:

The basic structure of the template includes: view structure (contains only chart structures)

Explanation of the main structure of templateInfo

Parameter Name	Type	Required	Description
name	string	Required	Note title
main	json		Main structure of exported content
main.charts	array		Chart template structure list
main.charts[#]	json		Chart template structure

Explanation of the structure of main.charts[#]

Parameter Name	Type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
queries	array[json]	Required	List of chart query statement structures

Structure of Time Series Chart with type=sequence, its main structure parameters are as follows:

Parameter Name	Type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
queries	array[json]	Required	List of chart query statement structures

Request Example¶

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

Response¶

{
    "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"
}