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 a template consists of: view structure (containing only chart structure).

Description 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		List of chart template structures
main.charts[#]	json		Chart template structure

Description 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 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.truewatch.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"
}