조회¶
GET /api/v1/notes_v2/{note_uuid}/get
개요¶
지정한 새 버전 노트의 메타데이터와 Markdown 본문을 조회합니다.
호출 전 및 사용 단계¶
새 버전 노트 목록에서 제공하는 UUID를 사용합니다. 공개 노트는 읽기 권한이 있는 Key로 조회할 수 있으며, 비공개 노트는 생성한 주체만 조회할 수 있습니다. 편집 또는 삭제 전에 응답의 etag를 기록하여 이후 ifMatch로 사용합니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| note_uuid | string | Y | 새 버전 노트 UUID입니다. 예시: nbnote_example가져오기 또는 입력 방법: 새 버전 노트 목록의 content.data[].noteUUID 또는 생성 결과의 content.noteUUID에서 복사합니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
JSON 객체를 반환합니다. 본문은 content.content에 담기며, 버전 검증은 content.etag를 사용합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notes_v2/nbnote_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여 줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 노트 레코드 번호입니다. |
| content.uuid | string | Studio 노트 식별자로, noteUUID와 동일합니다. |
| content.noteUUID | string | 상세 조회, 수정 및 삭제 경로에 사용되는 노트 UUID입니다. |
| content.title | string | 노트 제목입니다. |
| content.name | string | title과 동일한 엔터티 필드입니다. |
| content.workspaceUUID | string | 노트가 속한 워크스페이스 UUID입니다. |
| content.isPublic | integer | 1은 공개, 0은 비공개입니다. |
| content.tags | array<string> |
일반 태그입니다. |
| content.tagKV | object | 키-값 태그입니다. |
| content.extend | object | 비즈니스 확장 설정입니다. |
| content.createdSource | string | 생성 출처입니다. 예: manual 또는 ai. |
| content.noteType | string | normal, runbook 또는 statuspages입니다. |
| content.etag | string | 현재 ETag이며, 수정 또는 삭제 시 ifMatch로 사용할 수 있습니다. |
| content.version | integer | 현재 콘텐츠 버전 번호입니다. |
| content.nbookETag | string | etag와 동일한 엔터티 필드입니다. |
| content.nbookVersion | integer | version과 동일한 엔터티 필드입니다. |
| content.lastSyncAt | integer | 마지막 동기화 시간이며 Unix 초 단위입니다. |
| content.syncStatus | string | 콘텐츠 동기화 상태입니다. 예: synced. |
| content.syncError | string | 동기화 오류 설명이며, 동기화된 경우 일반적으로 비어 있습니다. |
| content.status | integer | 노트 상태입니다. |
| content.isFavourited | boolean | 현재 주체가 즐겨찾기로 표시했는지 여부입니다. |
| content.creator | string | 생성자 주체 식별자입니다. |
| content.updator | string | 최근 수정자 주체 식별자입니다. |
| content.createAt | number | 생성 시간이며 Unix 초 단위입니다. |
| content.updateAt | number | 수정 시간이며 Unix 초 단위입니다. 새로 생성된 경우 -1일 수 있습니다. |
| content.deleteAt | number | 삭제 시간이며 Unix 초 단위입니다. 삭제되지 않은 경우 -1입니다. |
| content.creatorInfo | object | 생성 주체의 추가 정보이며, 찾을 수 없는 경우 빈 객체입니다. |
| content.updatorInfo | object | 마지막 수정 주체의 추가 정보이며, 찾을 수 없는 경우 빈 객체입니다. |
| content.creatorInfo.uuid | string | 실제 주체 정보에 따라 제공됩니다. 주체 식별자입니다. |
| content.creatorInfo.status | integer | 실제 주체 정보에 따라 제공됩니다. 계정 상태입니다. |
| content.creatorInfo.wsAccountStatus | integer | 실제 주체 정보에 따라 제공됩니다. 워크스페이스 멤버 상태입니다. |
| content.creatorInfo.username | string | 실제 주체 정보에 따라 제공됩니다. 계정 로그인 이름입니다. |
| content.creatorInfo.name | string | 실제 주체 정보에 따라 제공됩니다. 표시 이름입니다. |
| content.creatorInfo.iconUrl | string | 실제 주체 정보에 따라 제공됩니다. 프로필 이미지 URL입니다. |
| content.creatorInfo.email | string | 실제 주체 정보에 따라 제공됩니다. 계정 이메일입니다. API Key 주체의 경우 해당 식별자가 반환될 수 있습니다. |
| content.creatorInfo.mobile | string | 실제 주체 정보에 따라 제공됩니다. 연락처입니다. |
| content.creatorInfo.countryCode | string | 실제 주체 정보에 따라 제공됩니다. 휴대폰 번호의 국가 또는 지역 코드입니다. |
| content.creatorInfo.acntWsNickname | string | 실제 주체 정보에 따라 제공됩니다. 워크스페이스 닉네임입니다. |
| content.updatorInfo.uuid | string | 실제 주체 정보에 따라 제공됩니다. 주체 식별자입니다. |
| content.updatorInfo.status | integer | 실제 주체 정보에 따라 제공됩니다. 계정 상태입니다. |
| content.updatorInfo.wsAccountStatus | integer | 실제 주체 정보에 따라 제공됩니다. 워크스페이스 멤버 상태입니다. |
| content.updatorInfo.username | string | 실제 주체 정보에 따라 제공됩니다. 계정 로그인 이름입니다. |
| content.updatorInfo.name | string | 실제 주체 정보에 따라 제공됩니다. 표시 이름입니다. |
| content.updatorInfo.iconUrl | string | 실제 주체 정보에 따라 제공됩니다. 프로필 이미지 URL입니다. |
| content.updatorInfo.email | string | 실제 주체 정보에 따라 제공됩니다. 계정 이메일입니다. API Key 주체의 경우 해당 식별자가 반환될 수 있습니다. |
| content.updatorInfo.mobile | string | 실제 주체 정보에 따라 제공됩니다. 연락처입니다. |
| content.updatorInfo.countryCode | string | 실제 주체 정보에 따라 제공됩니다. 휴대폰 번호의 국가 또는 지역 코드입니다. |
| content.updatorInfo.acntWsNickname | string | 실제 주체 정보에 따라 제공됩니다. 워크스페이스 닉네임입니다. |
| content.path | string | 서비스가 생성한 노트 문서 경로입니다. API 호출 시에는 noteUUID를 사용합니다. |
| content.content | string | 전체 Markdown 본문입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": 42,
"uuid": "nbnote_example",
"noteUUID": "nbnote_example",
"title": "프로덕션 점검 안내",
"name": "프로덕션 점검 안내",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"tags": [
"ops"
],
"tagKV": {
"service": "checkout"
},
"extend": {},
"createdSource": "manual",
"noteType": "runbook",
"etag": "etag-example-1",
"version": 1,
"nbookETag": "etag-example-1",
"nbookVersion": 1,
"lastSyncAt": 1785427200,
"syncStatus": "synced",
"syncError": "",
"status": 0,
"isFavourited": false,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"path": "manual/nbnote_example.md",
"content": "# 프로덕션 점검\n\n먼저 서비스 가용성을 확인한 뒤 최근 알림을 점검합니다.",
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
HTTP 424를 수신한 경우 content.upstreamStatus는 하위 서비스가 반환한 상태이며, 연결 이상 시 0일 수 있습니다. content.upstreamPath는 해당 실패 요청의 경로이고, content.responseBody는 하위 서비스의 오류 내용입니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | 활성 노트가 존재하지 않거나 현재 워크스페이스에 속하지 않음, 또는 현재 주체가 다른 사용자의 비공개 노트를 조회함 | 지정한 노트를 찾을 수 없습니다 | 동일한 워크스페이스의 목록에서 noteUUID를 확인합니다. 비공개 노트는 생성한 주체로 조회하세요. |
| 424 | ft.NbookDBApiError | 노트 서비스 요청 실패, 응답 이상 또는 서비스 사용 불가 | 노트 서비스 호출에 실패했습니다 | 먼저 content.upstreamStatus와 응답 내용을 확인합니다. traceId를 보관한 뒤 구체적인 원인에 따라 재시도하거나 관리자에게 문의하세요. |