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

Parameter Details¶

Note template structure description:

The basic structure of the template consists of: view structure (only containing chart structure)

templateInfo main structure description

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

main.charts[#] structure description

Parameter Name	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 parameters:

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