소명 템플릿 목록 조회
현재 세션이 속한 테넌트에 설정된 소명 템플릿 전체를 유형 코드별로 조회합니다. 특정 유형의 템플릿은 소명 템플릿 조회 API로 로케일별로 확인할 수 있습니다.
필요 권한
클러스터 관리자 권한이 필요합니다.
HTTP 요청
GET /api/sonar/push-templates
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
https://HOSTNAME/api/sonar/push-templates
정상 응답
{
"templates": {
"explanation_domain": "https://example.com",
"mail_explain_req_subject_ko": "[$category] 소명 요청 안내",
"sms_explain_req_msg_ko": "$category 건에 대한 소명 요청이 발송되었습니다. 기한: $expire_date",
"sms_explain_review_req_msg_ko": "$emp_name $emp_title 소명 검토 요청이 발송되었습니다. 기한: $expire_date"
}
}
-
templates (맵): 템플릿 키와 내용의 키/값 쌍입니다. 키는 아래 유형 코드에 로케일을 붙인
<유형 코드>_<로케일>형식이며(예:mail_explain_req_subject_ko,mail_explain_req_subject_en),explanation_domain만 로케일 없이 그대로 키로 사용됩니다. 테넌트에 저장된 모든 템플릿을 반환하므로 아래 표에 없는 유형 코드가 포함될 수 있습니다.유형 코드 설명 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 소명 완료 메일 본문 각 템플릿 내용에는 아래의 매크로를 사용할 수 있으며, 소명 요청이 발송될 때 실제 값으로 치환됩니다.
매크로 설명 $category 소명 분류명 $emp_key 소명 대상자 사번 $emp_name 소명 대상자 성명 $emp_title 소명 대상자 직급 $url 소명 제출 URL $expire_date 소명 제출 마감일 ( yyyy-MM-dd)$expire_time 소명 제출 마감시각 ( HH:mm:ss)$user_note 수동 소명 요청 시 입력한 설명 $create_date 소명 요청 생성일 ( yyyy-MM-dd)$create_time 소명 요청 생성시각 ( HH:mm:ss)
오류 응답
권한이 없는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "no-permission"
}