수정¶
POST /api/v1/viewer/{viewer_uuid}/modify
개요¶
기존 탐색기의 표시 정보, 확장 설정, 태그 또는 바인딩을 수정합니다.
호출 전 및 사용 단계¶
먼저 탐색기 상세로 현재 내용을 확인합니다. 변경이 필요한 필드만 제출합니다. extend, tagNames 또는 dashboardBindSet을 제출하면 해당 필드 전체가 교체됩니다. tagNames=[]는 기존 연결을 정리합니다. tagNames를 전달하지 않으면 기존 태그가 유지되며, 응답의 tagInfo는 빈 배열일 수 있으므로 상세로 확인할 수 있습니다. 동일한 탐색기의 설정 업데이트는 순차적으로 실행할 것을 권장합니다.
라우트 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| name | string | 탐색기 이름이며 최대 64자입니다. null 허용: False 최대 길이: 64 예시: 호스트 점검 탐색기획득 또는 입력 방법: 현재 워크스페이스에서 다른 탐색기가 사용하지 않는 이름을 선택합니다. |
|
| desc | string | 탐색기 설명이며 최대 2048자입니다. null 허용: False 빈 문자열 허용: True 최대 길이: 2048 예시: 호스트 점검 및 상태 확인획득 또는 입력 방법: 탐색기의 용도를 설명하며, 빈 문자열은 내용을 비우는 데 사용합니다. |
|
| type | string | 탐색기 유형입니다. null 허용: False 최대 길이: 32 예시: CUSTOM획득 또는 입력 방법: 일반적으로 CUSTOM을 사용합니다. 수정 시 상세의 content.type에서 가져와 그대로 사용할 수 있습니다. |
|
| extend | json | 탐색기 확장 정보입니다. 제출 시 전체 객체를 사용합니다. null 허용: False 예시: {}획득 또는 입력 방법: 탐색기 상세의 content.extend 또는 템플릿의 dashboardExtend에서 가져옵니다. |
|
| pathName | string | 호환용 경로 이름입니다. 현재 탐색기 엔터티는 이 필드를 별도로 저장하지 않습니다. null 허용: False 최대 길이: 32 예시: host획득 또는 입력 방법: 구버전 클라이언트가 이 필드를 포함할 수 있으며, 신규 연동에서는 생략할 것을 권장합니다. |
|
| tagNames | array | 전체 태그 목록입니다. []를 전달하면 비웁니다. null 허용: False 예시: ["team:ops"]획득 또는 입력 방법: 기존 탐색기 상세의 content.tagInfo[].name에서 복사하거나, 연결할 사용 사례 태그를 입력합니다. |
|
| tagNames[*] | string | 단일 태그 이름이며 최대 128자입니다. null 허용: False 최대 길이: 128 예시: team:ops획득 또는 입력 방법: 기존 탐색기 상세의 content.tagInfo[].name에서 복사하거나, 연결할 사용 사례 태그를 입력합니다. |
|
| dashboardBindSet | array | 저장할 탐색기 바인딩 뷰 정보 배열입니다. null 허용: False 빈 문자열 허용: False 예시: []획득 또는 입력 방법: 탐색기 상세의 content.dashboardBindSet에서 전체 바인딩 목록을 가져옵니다. 바인딩이 필요하지 않으면 빈 목록을 제출할 수 있습니다. |
파라미터 추가 설명¶
필드를 생략하면 현재 값이 유지됩니다. 업데이트 후 상세를 호출하여 설정을 확인할 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"호스트 점검 탐색기 v2"}'
응답¶
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.old_name | string | 업데이트 전 이름입니다. |
| content.dashboardBidding | object | 반환된 뷰 연결 설정이며 비어 있을 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": 25,
"uuid": "dsbd_view_example",
"name": "호스트 점검 탐색기 v2",
"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": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"old_name": "호스트 점검 탐색기",
"dashboardBidding": {},
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필드 타입 또는 값이 선언과 일치하지 않거나, 선언되지 않은 최상위 필드가 포함됨 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 타입 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 구문은 유효하지만 요청 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 파라미터를 JSON 객체로 전달합니다. |
| 404 | ft.NotFoundView | 대상이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 없음 | 지정된 뷰를 찾을 수 없음 | 동일한 워크스페이스의 탐색기 목록으로 유효한 UUID를 다시 확인합니다. |
| 400 | ft.TagScopeMismatch | 동일한 이름의 태그가 이미 존재하지만 범위가 사용 사례와 호환되지 않음 | 메시지에 태그 이름과 기존 및 대상 범위가 포함됩니다. | 사용 사례 또는 공통 태그로 변경합니다. |
| 400 | ft.ObjectParmeterExists | 새 이름이 현재 워크스페이스의 다른 탐색기에서 이미 사용 중임 | {} 이(가) 이미 존재합니다 |
사용되지 않은 탐색기 이름을 선택합니다. |