소명 요청 내역 상세 조회

지정한 소명 요청의 상세 정보를 조회합니다. 소명 요청에 제출된 소명 이력은 소명 이력 목록 조회 API로 확인할 수 있습니다.

필요 권한

소명 조회 권한을 가진 사용자 이상의 계정으로 이용하거나, 소명 요청 시 발급된 소명 토큰으로 세션 인증 없이 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/explanation-requests/49272877-75f2-4c2f-9301-d21c4f9a106d?type=EXPLANATION"

요청 매개변수

경로 매개변수

쿼리 매개변수

정상 응답

{
  "request": {
    "guid": "49272877-75f2-4c2f-9301-d21c4f9a106d",
    "employee_name": "홍길동",
    "employee_guid": "3f2a4b1c-8d7e-4a6f-9b2c-1d3e5f7a9c0b",
    "employee_title": "선임",
    "employee_department_name": "보안운영팀",
    "manager_name": "김관리",
    "manager_title": "팀장",
    "manager_department_name": "보안운영팀",
    "manager_result": null,
    "auditor_guid": null,
    "auditor_name": null,
    "auditor_result": null,
    "category_guid": "8270a382-a47c-401d-9318-037c5d639f2e",
    "category_name": "비정상 접근",
    "category_name_trans": {},
    "owner_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "owner_name": "김보안",
    "priority": "HIGH",
    "close_by_manager": false,
    "status": "SUBMITTED",
    "created": "2024-01-15 10:00:00+0900",
    "updated": "2024-01-15 10:30:00+0900",
    "expired": "2024-01-22 10:00:00+0900",
    "log_from": "2024-01-14 22:10:00+0900",
    "log_to": "2024-01-14 23:40:00+0900",
    "event_from": "2024-01-15 09:00:00+0900",
    "event_to": "2024-01-15 09:00:00+0900",
    "ticket_guid": null,
    "ticket_title": null,
    "ticket_id": null,
    "user_note": null,
    "locale": "ko"
  }
}

• request (맵): 소명 요청 상세 정보. 소명 요청이 존재하지 않으면 null입니다.
  • guid (문자열): 소명 요청 GUID
  • employee_name (문자열): 소명 대상자 성명
  • employee_guid (문자열): 소명 대상자 계정 GUID
  • manager_name (문자열): 1차 검토자 성명
  • manager_result (불리언): 1차 검토 결과. 위반이면 true, 정상이면 false, 미검토이면 null.
  • auditor_guid (문자열): 2차 검토자 계정 GUID
  • auditor_name (문자열): 2차 검토자 성명
  • auditor_result (불리언): 2차 검토 결과. 위반이면 true, 정상이면 false, 미검토이면 null.
  • category_guid (문자열): 소명 분류 GUID
  • category_name (문자열): 소명 분류 이름
  • category_name_trans (맵): 소명 분류 이름의 언어별 번역
  • owner_guid (문자열): 소명 요청자 계정 GUID
  • owner_name (문자열): 소명 요청자 성명
  • priority (문자열): 중요도. LOW, MEDIUM, HIGH 중 하나.
  • close_by_manager (불리언): 1차 검토자 전결 처리 여부
  • status (문자열): 소명 상태. NEW(미응답), SUBMITTED(제출), MANAGER_REJECTED(반려), MANAGER_CLOSED(전결), AUDITOR_SUBMITTED(검토 대기), AUDITOR_REJECTED(검토 반려), AUDITOR_CLOSED(검토 완료) 중 하나.
  • created (문자열): 소명 요청일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 수정일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • expired (문자열): 소명 마감 시한(yyyy-MM-dd HH:mm:ssZ 형식)
  • log_from (문자열): 근거 로그 최초 발생일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • log_to (문자열): 근거 로그 최근 발생일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • event_from (문자열): 근거 로그 조회 시작일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • event_to (문자열): 근거 로그 조회 종료일시(yyyy-MM-dd HH:mm:ssZ 형식)
  • ticket_guid (문자열): 연결된 티켓 GUID
  • ticket_title (문자열): 연결된 티켓 제목
  • ticket_id (32비트 정수): 연결된 티켓 번호
  • user_note (문자열): 소명 요청 메모
  • locale (문자열): 응답 언어 코드. 소명 토큰으로 접근한 경우 검토자 또는 대상자의 언어, 세션으로 접근한 경우 로그인 사용자의 언어입니다.
  • employee_title / manager_title / auditor_title / owner_title (문자열): 각 관련자의 직위. 해당 임직원 정보를 조회할 수 있을 때만 포함됩니다.
  • employee_department_name / manager_department_name / auditor_department_name / owner_department_name (문자열): 각 관련자의 부서 이름. 해당 임직원에 부서가 지정되어 있을 때만 포함됩니다.

오류 응답

type이 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "type should be not null"
}

type이 지원되지 않는 값인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "No enum constant com.logpresso.sonar.api.explanation.ExplanationType.INVALID"
}

guid가 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"
}