소명 제출 가능 여부 확인

지정한 소명 요청에 대해 현재 호출자가 소명, 1차 검토, 2차 검토를 제출할 수 있는지 확인합니다. 가능한 경우 null을, 불가능한 경우 사유 코드를 문자열로 반환합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/explanation-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/explainable?type=EXPLANATION"

요청 매개변수

경로 매개변수

요청 본문 매개변수

정상 응답

제출 가능한 경우 explainable 필드는 null입니다.

{
  "explainable": null
}

제출 불가능한 경우 explainable 필드에 사유 코드가 문자열로 반환됩니다.

{
  "explainable": "after-expired-at"
}

• explainable (문자열): 사유 코드. 가능한 값은 다음과 같습니다.
  • request-not-found: 소명 요청이 존재하지 않음
  • already-closed: 이미 종결된 요청
  • not-submitted: 1차 검토 단계에 도달하지 않음
  • already-submitted: 이미 2차 검토 단계로 제출됨
  • in-review: 검토 진행 중이라 임직원 추가 소명 불가
  • before-created-at: 소명 요청 생성 이전이라 작성 불가
  • after-expired-at: 마감 기한 경과로 작성 불가
  • invalid-session: 토큰 또는 세션이 유효하지 않음
  • not-employee: 임직원 정보가 없거나 검토자로 지정되지 않음
  • no-permission: 검토 권한 부족
  • invalid-type: 지원하지 않는 소명 종류

오류 응답

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

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-state",
  "error_msg": "no-permission"
}