보고서 그룹 조회
식별자로 지정한 보고서 그룹을 조회합니다.
필요 권한
사용자 이상의 계정으로 이용할 수 있습니다.
HTTP 요청
GET /api/sonar/report-groups/:guid
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
https://HOSTNAME/api/sonar/report-groups/8cdf8f7e-ebc6-4100-88f8-e97297cf5fc2
요청 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| guid | O | 문자열 | 보고서 그룹 식별자 | GUID 형식 36자 |
정상 응답
{
"group": {
"guid": "8cdf8f7e-ebc6-4100-88f8-e97297cf5fc2",
"name": "보고서 그룹",
"description": null,
"owner_guid": "ce23adf2-13e4-40f9-ad0c-74d090b1f10c",
"owner_name": "데모",
"parent_guid": null,
"created": "2024-08-08 10:28:17+0900",
"updated": "2024-08-08 10:28:17+0900"
}
}
- group (맵): 보고서 그룹
- guid (문자열): 보고서 그룹 식별자
- name (문자열): 보고서 그룹 이름
- description (문자열): 보고서 그룹에 대한 설명
- owner_guid (문자열): 소유자 식별자
- owner_name (문자열): 소유자 성명
- parent_guid (문자열): 상위 보고서 그룹 식별자
- created (문자열): 생성일시 (
yyyy-MM-dd HH:mm:ssZ형식) - updated (문자열): 수정일시 (
yyyy-MM-dd HH:mm:ssZ형식)
오류 응답
보고서 그룹이 존재하지 않는 경우
HTTP 상태 코드 200 응답
{
"group": null
}
식별자가 GUID 형식이 아닌 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-param-type",
"error_msg": "guid should be guid type."
}
보고서 그룹 조회 권한이 없는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "no-permission"
}