Export¶

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

Overview¶

Export the note specified by notes_uuid as a template structure

Route Parameters¶

Parameter	Type	Required	Description
notes_uuid	string	Y	Note UUID

Parameter Additional Notes¶

Note template structure description:

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

templateInfo Main Structure Description

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

main.charts[#] Structure Description

Parameter	Type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
queries	array[json]	Required	Chart query statement structure list

**Time Series Chart Structure type=sequence Main Structure Parameters: **

Parameter	Type	Required	Description
name	string	Required	Chart name
type	string	Required	Chart type
queries	array[json]	Required	Chart query statement structure list

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