콘텐츠로 이동

내보내기


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

문서 평가

이 페이지가 도움이 되었나요?