Get Push Template
Gets a specified push template setting of the company (tenant) in the current session.
Required Permissions
Requires the MASTER role.
HTTP Request
GET /api/sonar/push-templates/:type
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
https://HOSTNAME/api/sonar/push-templates/sms_explain_req_msg
Request Parameter
| Key | Required | Type | Description | Note |
|---|---|---|---|---|
| type | O | String | Template type | Refer to the below table. |
Refer to the below table for available template types:
| Template type | Description |
|---|---|
| explanation_domain | Submission domain. https://DOMAIN format |
| mail_explain_req_subject | Title of explanation request email |
| mail_explain_req_body | Boby of explanation request email |
| mail_explain_review_req_subject | Title of review request email |
| mail_explain_review_req_body | Boby of review request email |
| sms_explain_req_msg | Explanation request SMS message |
| sms_explain_review_req_msg | Review request SMS message |
Success Response
{
"template": "An explanation request for the $category case has been mailed to you. Due: $expire_date"
}
-
template (String): Template content
You can use the following macros for template content:
Macro Description $category Category $emp_key Employee number $emp_name Employee name $emp_title Employee title $url Submission URL $expire_date Submission due date (yyyy-MM-dd) $expire_time Submission due time (HH:mm:ss) $user_note User note in case of auto-request
Error Responses
Template type is not supported
HTTP status code 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."
}