| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nerrorFormat\n\n | \n\nHTML formatting to use for errors. Data type: String\n\n Default: `\"${%s}\"`\n\n |
| \n\nincludeEvaluatedBody\n\n | \n\nFlag that indicates whether to render the template variables.Valid values:\n\n - false: Do not render the template variables. The response contains the message variables.\n\nFor example:\n\n ```\nPlease note that your case ${number} has been escalated to ${assignment_group}.\n ```\n\n- true: Renders the template variables and returns **evaluated\\_response** in the return results.\n\nFor example:\n\n ```\nPlease note that your case INC100001 has been escalated to Facilities.\n ```\n\n\n Data type: Boolean\n\n Default: false\n\n |
| \n\nlimit\n\n | \n\nMaximum number of response templates to return.Data type: Number\n\n Default: 50\n\n |
| \n\noffset\n\n | \n\nFor pagination, the index at which to start the search.Data type: Number\n\n Default: 0\n\n |
| \n\nopts\n\n | \n\nParameters to pass to the sn\\_templated\\_snip.response\\_template extension point. The format and content of these parameters are dependent on the implementation of the extension point. For additional information on extension points, see [Using extension points to extend application functionality](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/extension-points.md).Data type: Object\n\n |
| \n\nrecordId\n\n | \n\nRequired. Sys\\_id of the record to use to render the variables in the response template.Data type: String\n\n |
| \n\nsearchTerm\n\n | \n\nText to use to filter the list of matching response templates.The endpoint performs a CONTAINS search of this text on the name and body fields and a STARTS WITH search on the short name field. For example, if the search term is \"crash\", the endpoint returns any response template that matches the query criteria and has crash in the name or body or the short name starts with crash.\n\n Response templates with exact matches on short name appear first in the return results. All other returned response templates are sorted by name.\n\n Data type: String\n\n Default: Return all matching response templates.\n\n |
| \n\ntableName\n\n | \n\nRequired. Name of the table to use to search the Response Templates table to locate corresponding response templates. For example, \"incident\" or \"sn\\_hr\\_core\\_case\".Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nresult\n\n | \n\nArray of objects that list all of the templates that match the specified search criteria.\n\n Data type: Array\n\n ```\n\"result\": [\n {Object}\n]\n```\n\n |
| \n\nresult.<object>\n\n | \n\nResponse templates with exact matches on short name appear first in the return results. All other returned response templates are sorted by name.\n\n Data type: Object\n\n ```\n{\n \"evaluated_response\": [Array],\n \"name\": \"String\",\n \"short_name\": \"String\",\n \"short_name_match\": Boolean,\n \"sys_id\": \"String\",\n \"template_body\": \"String\"\n}\n```\n\n |
| \n\nresult.<object>.evaluated\\_response\n\n | \n\nArray that lists the results of the template evaluation.\n\n Data type: Array\n\n ```\n\"elevated_response\":[\n \"error\": [Array],\n \"evaluated_body\": \"String\",\n \"success\": Boolean\n]\n```\n\n |
| \n\nresult.<object>.evaluated\\_response.error\n\n | \n\nList of entries for each evaluation error that occurred.\n\n Data type: Array\n\n ```\n\"error\":[\n \"inAccessibleVariables\": \"String\",\n \"message\": \"String\",\n \"unEvaluatedVariables\": \"String\"\n]\n```\n\n |
| \n\nresult.<object>.evaluated\\_response.error.inAccessibleVariables\n\n | \n\nVariables in the response template body that could not be resolved.Data type: String\n\n |
| \n\nresult.<object>.evaluated\\_response.error.message\n\n | \n\nError message.Data type: String\n\n |
| \n\nresult.<object>.evaluated\\_response.error.unEvaluatedVariables\n\n | \n\nVariables in the response template body that were not evaluated.Data type: String\n\n |
| \n\nresult.<object>.evaluated\\_response.evaluated\\_body\n\n | \n\nEvaluated response template body in HTML.Data type: String\n\n |
| \n\nresult.<object>.evaluated\\_response.success\n\n | \n\nFlag that indicates whether all of the variables rendered properly.\n\n Possible values:\n\n- true: All variables rendered properly.\n- false: Variables did not render properly.\n\n Data type: Boolean\n\n |
| \n\nresult.<object>.name\n\n | \n\nName of the response template.Data type: String\n\n |
| \n\nresult.<object>.short\\_name\n\n | \n\nShort name of the response template.Data type: String\n\n |
| \n\nresult.<object>.short\\_name\\_match\n\n | \n\nFlag that indicates whether an exact match occurred on the short name of the response template.\n\n Possible values:\n\n- true: Search term is an exact match.\n- false: Search term is not an exact match.\n\n Data type: Boolean\n\n |
| \n\nresult.<object>.sys\\_id\n\n | \n\nSys\\_id of the response template.Data type: String\n\n |
| \n\nresult.<object>.template\\_body\n\n | \n\nResponse template body in HTML.Data type: String\n\n |
Dear ${subject_person},<\\/p>\\n
Please note that your case ${number} has been escalated to ${assignment_group}. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.<\\/p>\\n
Regards,<\\/p>\\n
${sys_updated_by}<\\/p>\"\n },\n {\n \"sys_id\": \"698388ec0b03320036e62c7885673ab5\",\n \"name\": \"Resolution Notes - Phone Inquiry\",\n \"short_name\": \"Resolution Notes - Phone Inquiry\",\n \"template_body\": \"
Thank you ${subject_person} for reaching out to the Global HR Services Team for your inquiry. As discussed over the phone, we have resolved your case ${number}.<\\/p>\\n
We are happy to help if you have more questions for our team. Please reach out and mention the case number ${number} on the call.<\\/p>\\n
Regards,<\\/p>\\n
${assigned_to}<\\/p>\"\n }\n ]\n}\n```\n\n"}}