소명 제출

지정한 소명 요청에 대해 임직원의 소명 또는 1차/2차 검토자의 의견을 작성하고 처리 상태를 변경합니다. type 매개변수에 따라 작성자 정보가 결정됩니다.

필요 권한

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

HTTP 요청

POST /api/sonar/explanation-requests/:request_guid

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "type": "EXPLANATION",
       "status": "SUBMITTED",
       "result": 0,
       "content": "정기 점검 일정에 따라 수행한 작업입니다."
     }' \
     https://HOSTNAME/api/sonar/explanation-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890

요청 매개변수

경로 매개변수

키	타입	설명	비고
request_guid	문자열	소명 요청 식별자	36자 GUID

요청 본문 매개변수

키	필수	타입	설명
type	O	문자열	소명 종류. `EXPLANATION` (소명), `MANAGER_COMMENT` (1차 검토), `AUDITOR_COMMENT` (2차 검토) 중 하나
status	O	문자열	변경할 상태. `SUBMITTED`, `MANAGER_REJECTED`, `MANAGER_CLOSED`, `AUDITOR_SUBMITTED`, `AUDITOR_REJECTED`, `AUDITOR_CLOSED` 중 하나
result	O	32비트 정수	검토 결과. `0`은 정상, `1`은 위반
content	O	문자열	소명 또는 의견 내용
token	X	문자열	비로그인 호출 시 사용하는 소명 토큰. 임직원 또는 1차 검토자에게 메일로 발송된 토큰

정상 응답

{}

오류 응답

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

HTTP 상태 코드 400 응답

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

소명 요청이 존재하지 않는 경우

HTTP 상태 코드 500 응답

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

제출이 불가능한 상태인 경우

HTTP 상태 코드 500 응답으로 소명 제출 가능 여부 확인 API의 사유 코드 중 하나를 반환합니다.

{
  "error_code": "illegal-state",
  "error_msg": "after-expired-at"
}

검토자로 지정되지 않은 임직원이 호출한 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "not-employee"
}

권한이 없거나 토큰이 유효하지 않은 경우

HTTP 상태 코드 500 응답

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