가져오기¶
POST /api/v1/notes/{notes_uuid}/import
개요¶
템플릿을 사용하여 지정된 레거시 노트의 차트 콘텐츠를 다시 생성합니다.
호출 전과 사용 단계¶
먼저 노트 내보내기로 대상 노트를 백업합니다. 전체 템플릿을 templateInfo에 전달합니다. 경로의 노트 UUID는 유지되며, 기존 pos에서 참조한 차트는 소프트 삭제되고, 가져온 차트는 UUID가 다시 생성됩니다. templateInfo 또는 main.charts가 누락된 경우 실행이 성공해도 차트가 비워집니다. extend가 누락되면 {}로 덮어씁니다. 먼저 템플릿을 검증하고, 완료 후 노트 상세에서 차트와 이름을 다시 확인합니다.
경로 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| templateInfo.name | string | 값이 비어 있지 않으면 현재 노트 이름을 덮어씁니다. 생략하거나 빈 문자열이면 유지합니다. 예시: 生产巡检笔记확인 또는 입력 방법: 내보낸 템플릿의 name 값을 사용하고, 필요에 따라 이름을 변경합니다. |
|
| templateInfo.extend | object | 노트의 확장 객체이며, 생략하면 {}로 덮어씁니다. 예시: {}확인 또는 입력 방법: 내보낸 템플릿의 extend에서 가져옵니다. |
|
| templateInfo.main | object | 콘텐츠 본문이며, 누락되면 기존 차트가 비워집니다. 예시: {"charts": [{"name": "巡检说明", "type": "text", "queries": [{"query": {"content": "按仪表板核对生产状态。"}}], "extend": {}}]}확인 또는 입력 방법: 내보낸 템플릿의 main에서 가져옵니다. |
|
| templateInfo.main.charts | array | 가져오는 전체 차트 목록입니다. 누락되거나 []를 전달하면 차트가 비워집니다. 예시: [{"name": "巡检说明", "type": "text", "queries": [{"query": {"content": "按仪表板核对生产状态。"}}], "extend": {}}]확인 또는 입력 방법: main.charts의 전체 차트 배열을 사용하고 순서를 정합니다. |
|
| templateInfo.main.charts[].name | string | 차트 이름이며 최대 256자입니다. 생략하면 기본값은 빈 문자열입니다. 예시: 巡检说明확인 또는 입력 방법: 내보낸 차트의 이름을 사용하거나 새 이름을 입력합니다. |
|
| templateInfo.main.charts[].type | string | 차트 유형입니다. 생략하면 line을 사용합니다. 예시: text확인 또는 입력 방법: 내보낸 차트의 type을 우선 사용합니다. 텍스트 본문 예시는 text를 사용합니다. |
|
| templateInfo.main.charts[].queries | array | 차트 쿼리 또는 본문 정의입니다. 생략하면 기본값은 []입니다. 예시: [{"query": {"content": "按仪表板核对生产状态。"}}]확인 또는 입력 방법: 동일한 유형의 차트에 있던 queries를 복사합니다. |
|
| templateInfo.main.charts[].queries[].query.content | string | text 차트 본문 예시의 content 필드입니다. 예시: 按仪表板核对生产状态。확인 또는 입력 방법: 텍스트형 차트에는 표시할 본문을 입력합니다. 다른 유형은 내보낸 콘텐츠를 그대로 사용합니다. |
|
| templateInfo.main.charts[].extend | object | 확장 설정입니다. 생략하면 {}입니다. 예시: {}확인 또는 입력 방법: 내보낸 차트의 extend 설정을 사용합니다. |
|
| templateInfo | json | 가져올 템플릿 객체입니다. name이 비어 있지 않으면 노트 이름을 덮어쓸 수 있습니다. 전체 템플릿을 명확하게 제출하세요. null 허용: False 예시: {"name": "生产巡检笔记", "extend": {}, "main": {"charts": [{"name": "巡检说明", "type": "text", "queries": [{"query": {"content": "按仪表板核对生产状态。"}}], "extend": {}}]}}확인 또는 입력 방법: 노트 내보내기에서 main.charts를 포함하는 content를 가져옵니다. 템플릿의 차트 순서와 파라미터가 올바른지 확인하세요. |
파라미터 추가 설명¶
이 작업은 기존 차트를 덮어씁니다. 템플릿 형식은 내보내기 API에서 가져온 JSON을 사용하며, 필요에 따라 이름과 차트 콘텐츠를 교체합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notes/note_example/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"templateInfo":{"name":"生产巡检笔记","extend":{},"main":{"charts":[{"name":"巡检说明","type":"text","queries":[{"query":{"content":"按仪表板核对生产状态。"}}],"extend":{}}]}}}'
응답¶
HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer | 노트 레코드 번호입니다. |
| content.uuid | string | 노트 UUID이며 조회, 수정, 가져오기 및 삭제에 사용됩니다. |
| content.name | string | 노트 이름입니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.isPublic | integer | 공개 범위입니다. 1은 공개, 0은 생성자 ID만 볼 수 있습니다. |
| content.extend | object | 노트 확장 설정입니다. |
| content.status | integer | 노트의 현재 상태입니다. |
| content.creator | string | 생성자 ID입니다. |
| content.updator | string | 최근 업데이트한 주체의 ID이며, 업데이트하지 않은 경우 비어 있을 수 있습니다. |
| content.createAt | number | 생성 시간(Unix 초)입니다. |
| content.updateAt | number | 최근 업데이트 시간(Unix 초)입니다. 업데이트하지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | number | 삭제 시간(Unix 초)입니다. 삭제되지 않은 경우 -1입니다. |
| content.pos | array<object> |
차트의 순서 참조 배열입니다. |
| content.pos[].chartUUID | string | 차트 UUID입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "生产巡检笔记",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"pos": [
{
"chartUUID": "chrt_example"
}
],
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | templateInfo가 null이거나, 타입이 잘못되었거나, 선언되지 않은 최상위 요청 필드가 포함된 경우 | 파라미터 구문 분석 실패 | 요청 파라미터 표에 따라 객체를 제출하고, 내보내기 API가 반환한 전체 템플릿을 사용합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않은 경우 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 구문은 유효하지만 요청 최상위가 객체가 아닌 경우 | 일부 json 파일의 형식이 잘못되었습니다. | 파라미터를 JSON 객체에 넣은 후 다시 시도합니다. |
| 404 | ft.NotFoundNote | UUID가 삭제되었거나, 존재하지 않거나, 현재 API Key의 워크스페이스에 없는 경우 | 지정한 노트를 찾을 수 없습니다. | 동일한 워크스페이스의 노트 목록에서 UUID를 확인합니다. |
| 403 | ft.ForbiddenFreeEditionLimit | 워크스페이스에서 해당 할당량이 활성화되어 있고 레거시 노트 수가 상한에 도달한 경우 | 무료 플랜 워크스페이스 {}가 상한({}개)에 도달하여 새로 생성할 수 없습니다. 상용 플랜을 활성화하면 제한이 해제됩니다. | 워크스페이스 버전과 노트 수를 확인한 후 할당량 또는 리소스를 조정합니다. |
| 406 | ft.ExceedMaxCharacterLimit | 템플릿 내 차트 이름이 지원 길이를 초과한 경우 | {}이(가) 최대 문자 길이 제한을 초과했습니다. | 차트 이름을 최대 256자로 변경한 후 템플릿과 백업을 다시 확인합니다. |