내보내기¶
GET /api/v1/notes/{notes_uuid}/export
개요¶
레거시 노트와 해당 차트 정의를 내보내 이후 가져오기에 사용할 수 있도록 합니다.
호출 전 및 사용 단계¶
노트 목록에서 노트 UUID를 가져옵니다. 응답의 content를 템플릿으로 보관합니다. 대상 워크스페이스에서 빈 노트를 생성한 후 노트 가져오기를 통해 해당 템플릿을 적용할 수 있습니다. 내보내기 이름만 변경하려면 name을 전달할 수 있습니다.
경로 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notes_uuid | string | Y | 대상 레거시 노트의 UUID입니다. 예: note_example가져오기 또는 입력 방법: 노트 목록의 content.data[].uuid에서 가져오거나 생성 응답의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 선택 사항입니다. 내보내기 콘텐츠의 name을 대체하며 원본 노트에는 저장되지 않습니다. 예: 巡检模板가져오기 또는 입력 방법: 템플릿에 사용할 이름을 입력하고 일반 Query로 URL 인코딩합니다. |
매개변수 추가 설명¶
템플릿 JSON을 반환하며, content를 저장하면 이후 templateInfo로 사용할 수 있습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notes/note_example/export' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.name | string | 템플릿의 노트 이름입니다. |
| content.extend | object | 노트 확장 설정입니다. |
| content.main | object | 노트 콘텐츠 정의입니다. |
| content.main.charts | array<object> |
노트에 저장된 순서대로 내보낸 차트 정의입니다. |
| content.main.charts[].name | string | 내보낸 차트 이름입니다. |
| content.main.charts[].type | string | 내보낸 차트 유형입니다. |
| content.main.charts[].queries | array<object> |
차트 쿼리 또는 콘텐츠 정의입니다. |
| content.main.charts[].extend | object | 차트 확장 설정입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공용 선언입니다. |
{
"code": 200,
"content": {
"name": "生产巡检笔记",
"extend": {},
"main": {
"charts": [
{
"name": "巡检说明",
"type": "text",
"queries": [
{
"query": {
"content": "按仪表板核对生产状态。"
}
}
],
"extend": {}
}
]
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공용 요청 오류는 공용 오류 정의를 참조하세요.
대상이 존재하지 않거나 현재 워크스페이스에 속하지 않는 경우 성공과 빈 객체가 반환될 수 있습니다. name을 전달한 경우 템플릿 이름과 선언만 반환될 수도 있습니다. 템플릿을 사용하기 전에 main.charts가 반환되었는지 확인하세요.