기능 메뉴 조회¶
GET /api/v1/workspace/menu/get
개요¶
워크스페이스 1차 메뉴 호환 구성을 읽습니다.
호출 전 및 사용 단계¶
routine.defaultAccess 등 허용된 권한이 있는 현재 워크스페이스 Key를 사용합니다. 워크스페이스 메뉴 구성 또는 기본 프로젝션을 반환하며, 현재 자격으로 최종 액세스할 수 있는 메뉴가 아닙니다. 가시성은 페이지/API/데이터 권한 부여를 대체할 수 없습니다. 저장되지 않은 경우 메모리에서만 사이트 기본값을 상속하여 변환하며, 구성을 생성하지 않습니다. v3가 이미 있으면 호환 프로젝션을 반환하며, 시스템/레거시 호환 메뉴만 포함하고 사용자 지정 디렉터리와 리소스는 포함하지 않으며, 역할별 설정도 완전히 표현하지 않습니다.
v1은 1차 key/value만 반환하며, 숨김 값은 플랫폼 isHide와 워크스페이스 isShow를 이미 합성한 값입니다. 2차 메뉴가 필요하거나 플랫폼/워크스페이스 표시 여부를 구분하려면 v2를, 전체 트리와 역할은 v3를 사용합니다.
Owner 자격으로 검수할 때 유의해야 합니다. 유효 메뉴 계산은 워크스페이스 isShow 숨김을 무시하지만(구분선 제외), 여전히 플랫폼 숨김과 실제 권한의 제약을 받습니다. 일반 역할과 Owner의 최종 표시는 다를 수 있습니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
요청 예시¶
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스 UUID입니다. |
| content.config | array<object> |
메뉴 구성 배열이며, 빈 결과도 []일 수 있습니다. |
| content.keyCode | string | 호환 메타데이터입니다. 저장/v3 호환 프로젝션에서는 일반적으로 WsMenuCfg이며, 신규 워크스페이스의 이전 읽기 분기에서는 생략될 수 있습니다. |
| content.updated | boolean | 워크스페이스 구성 또는 v3 호환 프로젝션이 존재하면 일반적으로 true입니다. 이번 쓰기의 변경 여부를 나타내는 신뢰할 수 있는 지표는 아니며, 신규 워크스페이스에서는 생략될 수 있습니다. |
| content.id | integer 또는 null | 저장된 구성의 데이터베이스 번호이며, 생략될 수 있습니다. |
| content.uuid | string | ctcf_ 구성 UUID이며, 생략될 수 있고 메뉴 노드 ID로 사용되지 않습니다. |
| content.creator | string | 구성 생성 주체이며, 생략될 수 있습니다. |
| content.updator | string | 구성 수정 주체이며, 생략될 수 있습니다. |
| content.status | integer | 구성 엔터티 상태이며, 생략될 수 있습니다. |
| content.createAt | integer | 생성 Unix 초이며, 생략될 수 있습니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 생략될 수 있습니다. |
| content.deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1이고 생략될 수 있습니다. |
| content.declaration | object | 현재 워크스페이스의 공용 선언입니다. |
| content.config[].key | string | 1차 시스템 메뉴 Key이며, 현재 이전 프로토콜 GET에서 가져온 값을 사용하고 표시 이름이나 v3 노드 ID를 사용하지 않습니다. |
| content.config[].value | integer | 최종 프로젝션 표시/숨김: 1은 표시, 0은 숨김이며, 워크스페이스 isShow와 플랫폼 isHide를 합성한 값입니다. |
{
"code": 200,
"content": {
"workspaceUUID": "wksp_example",
"config": [
{
"key": "Scene",
"value": 1
},
{
"key": "Notebook",
"value": 1
},
{
"key": "Events",
"value": 1
},
{
"key": "ExceptionsTracking",
"value": 1
},
{
"key": "Incident",
"value": 1
},
{
"key": "Error",
"value": 1
},
{
"key": "Objectadmin",
"value": 1
},
{
"key": "Entity",
"value": 1
},
{
"key": "DataObservability",
"value": 1
},
{
"key": "MetricQuery",
"value": 1
},
{
"key": "LogIndi",
"value": 1
},
{
"key": "Tracing",
"value": 1
},
{
"key": "Rum",
"value": 1
},
{
"key": "CloudBilling",
"value": 1
},
{
"key": "CloudDial",
"value": 1
},
{
"key": "Security",
"value": 1
},
{
"key": "AIMonitor",
"value": 1
},
{
"key": "GitLabCI",
"value": 1
},
{
"key": "Monitor",
"value": 1
},
{
"key": "Integration",
"value": 1
},
{
"key": "Workspace",
"value": 1
},
{
"key": "Billing",
"value": 1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 구성 중복/형식 손상, 데이터베이스 읽기 또는 응답 포맷팅 실패 | 내부 오류 | traceId를 제공하여 관리자가 구성을 확인하도록 하십시오. 구성을 비워 손상을 숨기지 마십시오. |