조회¶
GET /api/v1/notes/{notes_uuid}/get
개요¶
레거시 노트의 상세 정보와 차트를 조회합니다.
호출 전 및 사용 단계¶
노트 목록에서 제공하는 UUID를 사용합니다. 결과의 charts에서 현재 활성 차트를 읽으며, 차트 이름, 유형 및 쿼리 정의를 포함합니다. 결과는 노트 내 차트 순서를 우선으로 하고, 순서 목록에 없는 소속 차트를 뒤에 추가합니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
파라미터 추가 설명¶
상세 정보의 charts는 소속 노트를 기준으로 조회된 차트 객체입니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notes/note_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 노트 레코드 번호입니다. |
| content.uuid | string | 노트 UUID로, 조회, 수정, 가져오기 및 삭제에 사용됩니다. |
| content.name | string | 노트 이름입니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.isPublic | integer | 공개 범위이며, 1은 공개, 0은 생성한 아이덴티티만 볼 수 있습니다. |
| 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.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.charts | array<object> |
현재 노트에 속한 유효한 차트입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공개 선언입니다. |
| content.charts[].id | integer | 차트 레코드 번호입니다. |
| content.charts[].uuid | string | 차트 UUID입니다. |
| content.charts[].name | string | 차트 이름입니다. |
| content.charts[].type | string | 차트 유형입니다. |
| content.charts[].notesUUID | string | 차트가 속한 노트 UUID입니다. |
| content.charts[].workspaceUUID | string | 소속 워크스페이스입니다. |
| content.charts[].chartGroupUUID | string | 소속 차트 그룹이며, 빈 문자열일 수 있습니다. |
| content.charts[].dashboardUUID | string | 연결된 대시보드 식별자이며, 빈 문자열일 수 있습니다. |
| content.charts[].isWorkspaceKeyIndicator | integer | 워크스페이스 핵심 지표로 표시되었는지 여부이며, 0은 아니요, 1은 예입니다. |
| content.charts[].queries | array<object> |
쿼리 또는 노트 콘텐츠 정의입니다. |
| content.charts[].extend | object | 차트 확장 설정입니다. |
| content.charts[].status | integer | 차트의 현재 상태입니다. |
| content.charts[].creator | string | 생성자 아이덴티티 ID입니다. |
| content.charts[].updator | string | 최근 업데이트한 아이덴티티 ID이며, 업데이트가 없으면 비어 있을 수 있습니다. |
| content.charts[].createAt | number | 생성 시간이며 Unix 초 단위입니다. |
| content.charts[].updateAt | number | 최근 업데이트 시간이며 Unix 초 단위입니다. 업데이트가 없으면 -1입니다. |
| content.charts[].deleteAt | number | 삭제 시간이며 Unix 초 단위입니다. 삭제되지 않았으면 -1입니다. |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "프로덕션 점검 노트",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"charts": [
{
"name": "점검 설명",
"type": "text",
"queries": [
{
"query": {
"content": "대시보드 기준으로 프로덕션 상태를 확인합니다."
}
}
],
"extend": {},
"id": 40,
"uuid": "chrt_example",
"workspaceUUID": "wksp_example",
"notesUUID": "note_example",
"chartGroupUUID": "",
"dashboardUUID": "",
"isWorkspaceKeyIndicator": 0,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | UUID가 삭제되었거나 존재하지 않거나 현재 API Key의 워크스페이스에 속하지 않음 | 지정된 노트를 찾을 수 없음 | 동일 워크스페이스의 노트 목록에서 UUID를 확인합니다. |