소명 템플릿 조회

지정한 유형의 소명 템플릿 내용을 로케일별로 조회합니다. 전체 유형의 템플릿은 소명 템플릿 목록 조회 API로 확인할 수 있으며, 템플릿 내용은 소명 템플릿 설정 API로 변경할 수 있습니다.

필요 권한

클러스터 관리자 권한이 필요합니다.

HTTP 요청

GET /api/sonar/push-templates/:type
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/push-templates/mail_explain_req_subject?locale=ko"
요청 매개변수
경로 매개변수
키타입설명비고
type문자열템플릿 유형아래 유형 코드 중 하나

type에는 아래의 유형 코드 중 하나를 지정합니다.

유형 코드설명
explanation_domain소명 작성 웹페이지 도메인 주소
mail_explain_req_subject소명 요청 메일 제목
mail_explain_req_body소명 요청 메일 본문
mail_explain_review_req_subject검토 요청 메일 제목
mail_explain_review_req_body검토 요청 메일 본문
sms_explain_req_msg소명 요청 SMS 본문
sms_explain_review_req_msg검토 요청 SMS 본문
mail_explain_complete_subject소명 완료 메일 제목
mail_explain_complete_body소명 완료 메일 본문
쿼리 매개변수
키필수타입설명비고
localeX문자열로케일en, ko, ja, zh 중 하나. 미지정 시 기본 템플릿

정상 응답

{
  "template": "[$category] 소명 요청 안내"
}
  • template (문자열): 지정한 유형과 로케일의 소명 템플릿 내용. 설정된 값이 없으면 null

오류 응답

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}
type가 지원되는 유형 코드가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "type should be one of explanation_domain, mail_explain_req_subject, mail_explain_req_body, mail_explain_review_req_subject, mail_explain_review_req_body, sms_explain_req_msg, sms_explain_review_req_msg, mail_explain_complete_subject, mail_explain_complete_body."
}
locale가 지원되지 않는 값인 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "'de' is unsupported locale."
}