조회¶
GET /api/v1/viewer/{viewer_uuid}/get
개요¶
지정된 탐색기의 상세 정보와 레이아웃을 조회합니다.
호출 전 및 사용 단계¶
탐색기 목록에서 현재 워크스페이스의 UUID를 선택합니다. 상세 정보는 레이아웃과 연결 정보를 반환합니다. 이식 가능한 전체 템플릿이 필요하면 탐색기 내보내기를 사용합니다. showTemplate=true로 설정하면 기본 템플릿 정보를 확인할 수 있습니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| viewer_uuid | string | Y | 현재 워크스페이스의 대상 탐색기 UUID입니다. 예시: dsbd_view_example가져오기 또는 입력 방법: 탐색기 목록의 content.data[].uuid에서 가져오며, 생성 응답의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| showTemplate | boolean | 생략하면 기본 템플릿을 추가로 읽지 않습니다. 예시: true가져오기 또는 입력 방법: 연결된 기본 템플릿을 읽어야 할 때 true를 전달하며, 1도 허용됩니다. |
파라미터 추가 설명¶
템플릿 정보는 탐색기의 기본 템플릿 설정에서 가져옵니다. 탐색기 자체의 이식 가능한 JSON 구조는 내보내기 API에서 반환합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode showTemplate=true
응답¶
HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 탐색기 레코드 번호입니다. |
| content.uuid | string | 탐색기 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.name | string | 탐색기 이름입니다. |
| content.desc | string | 탐색기 설명입니다. |
| content.identifier | string | 사용자 정의 식별자이며 비어 있을 수 있습니다. |
| content.ownerType | string | 탐색기 리소스 소유 유형이며, 일반적으로 viewer입니다. |
| content.type | string | 탐색기 유형이며, 예를 들어 CUSTOM입니다. |
| content.isPublic | integer | 현재 리소스의 공개 범위입니다. 1은 공개, 0은 생성한 주체만 볼 수 있습니다. |
| content.chartPos | array<object> |
차트 레이아웃 배열이며 chartUUID와 레이아웃 객체 pos를 포함합니다. |
| content.chartPos[].chartUUID | string | 참조된 차트 UUID입니다. |
| content.chartPos[].pos | object | 레이아웃의 위치 및 크기입니다(예: x, y, w, h). |
| content.chartGroupPos | array<string> |
차트 그룹 정렬 순서입니다. |
| content.iconSet | object | 아이콘 설정입니다. |
| content.extend | object | 탐색기 확장 정보입니다. |
| content.mapping | array<object> |
변수 필드 매핑 정보입니다. |
| content.dashboardBindSet | array | 뷰 바인딩 설정입니다. |
| content.createdWay | string | 리소스 생성 출처입니다. |
| content.openPermissionSet | boolean | 엔터티 레코드의 권한 설정 스위치입니다. |
| content.permissionSet | array<string> |
레코드의 작업 권한 주체 UUID입니다. |
| content.readPermissionSet | array<string> |
레코드의 읽기 권한 주체 UUID입니다. |
| content.tagInfo | array<object> |
연결된 태그 정보입니다. |
| content.tagInfo[].id | string | 태그 UUID와 동일한 식별자입니다. |
| content.tagInfo[].uuid | string | 태그 UUID입니다. |
| content.tagInfo[].name | string | 태그 이름입니다. |
| content.tagInfo[].description | string | 태그 설명입니다. |
| content.tagInfo[].colour | string | 태그 색상입니다. |
| content.tagInfo[].scope | array<string> |
태그가 적용되는 범위입니다. |
| content.tagInfo[].tagPermissionInfo | 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.isFavorite | boolean | 현재 주체의 즐겨찾기 상태입니다. 상세에서 즐겨찾기하지 않은 경우 반환되지 않을 수 있습니다. |
| content.isIndexDashboard | boolean | 현재 워크스페이스의 홈 화면 뷰인지 여부입니다. |
| content.refCheckerUUIDs | array<string> |
연결된 모니터 식별자입니다. |
| content.integrationInfo | object | showTemplate=true 또는 1일 때 함께 제공되는 기본 템플릿 정보이며, 해당 항목이 없으면 빈 객체입니다. |
| content.extend.defaultTargetWorkspaceName | string | 이전 단일 워크스페이스 ID가 설정된 경우 해당 이름이 반환될 수 있습니다. |
| content.extend.defaultTargetWorkspaceNames | array<string> |
기본 조회 워크스페이스 목록이 설정된 경우 워크스페이스 이름 목록이 반환될 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스의 공용 선언입니다. |
{
"code": 200,
"content": {
"id": 25,
"uuid": "dsbd_view_example",
"name": "호스트 점검 탐색기",
"desc": "호스트 점검 및 상태 확인",
"workspaceUUID": "wksp_example",
"identifier": "",
"ownerType": "viewer",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"isIndexDashboard": false,
"refCheckerUUIDs": [],
"integrationInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundView | 대상이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 없음 | 지정된 뷰를 찾을 수 없습니다 | 동일한 워크스페이스의 탐색기 목록에서 유효한 UUID를 다시 확인합니다. |