소명 이력 목록 조회

지정한 소명 요청에 대해 기록된 소명, 1차 검토자 의견, 2차 검토자 의견 등의 작성 이력을 시간순으로 조회합니다. 로그인 세션 또는 메일로 발송된 소명 토큰을 사용해 호출할 수 있습니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다. 메일로 발송된 유효한 소명 토큰을 token 매개변수로 전달하면 비로그인 상태에서도 호출할 수 있습니다.

HTTP 요청

GET /api/sonar/explanations
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/explanations?guid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&type=EXPLANATION"
요청 매개변수
필수타입설명비고
guidO문자열소명 요청 식별자36자 GUID
typeO문자열소명 종류. EXPLANATION (소명), MANAGER_COMMENT (1차 검토), AUDITOR_COMMENT (2차 검토) 중 하나
tokenX문자열비로그인 호출 시 사용하는 소명 토큰. 임직원 또는 1차 검토자에게 메일로 발송된 토큰

정상 응답

{
  "explanations": [
    {
      "type": "EXPLANATION",
      "employee_name": "박현재",
      "employee_guid": "e722b073-892a-4e9e-ba78-d556324a1a82",
      "request_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": "정기 점검 일정에 따라 수행한 작업입니다.",
      "owner_guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "owner_name": "홍길동",
      "created": "2026-04-15 09:00:00+0900",
      "updated": "2026-04-15 09:00:00+0900"
    }
  ]
}
  • explanations (배열): 소명 이력 목록. 작성된 이력이 없으면 빈 배열
    • type (문자열): 소명 종류. EXPLANATION, MANAGER_COMMENT, AUDITOR_COMMENT 중 하나
    • employee_name (문자열): 작성자 임직원 성명
    • employee_guid (문자열): 작성자 임직원 식별자. 임직원 정보가 없으면 null
    • request_guid (문자열): 소명 요청 식별자
    • content (문자열): 소명 내용
    • owner_guid (문자열): 작성 계정 식별자. 외부 토큰 작성인 경우 null
    • owner_name (문자열): 작성 계정 이름
    • created (문자열): 작성일시. yyyy-MM-dd HH:mm:ssZ 형식
    • updated (문자열): 수정일시. yyyy-MM-dd HH:mm:ssZ 형식

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "guid should be not null"
}
식별자가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
소명 종류 값이 유효하지 않은 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-argument",
  "error_msg": "No enum constant com.logpresso.sonar.api.explanation.ExplanationType.INVALID"
}
권한이 없거나 토큰이 유효하지 않은 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}