---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Antwortvorlage: Umfang, Global

# Antwortvorlage: Umfang, Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die Antwortvorlage Die Skripteinbindung bietet Methoden für die Verwaltung von Antwortvorlagen.

Antwortvorlagen sind wiederverwendbare Nachrichten, die Service Desk-Mitarbeiter in Fall- oder Aufgabenformulare kopieren können. Sie stellen Anwendern schnelle und konsistente Nachrichten zur Verfügung und zeigen standardmäßige Chatantwortnachrichten für anfordernde Personen in an Mitarbeiterchat. Diese Skripteinbindung erfordert das Plugin „Antworten mit Vorlagen" (com.sn_templates_snip), das standardmäßig aktiviert ist und innerhalb von ausgeführt wird `sn_templates_snip `Namespace.

Weitere Informationen zu Antwortvorlagen finden Sie unter [Antwortvorlagen](https://www.servicenow.com/docs/access?context=response-templates-templated-snippets&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

## ResponseTemplate -- ResponseTemplate() {#ariaid-title2}

Instanziiert ein neues ResponseTemplate-Objekt.
{#RT-ResponseTemplate__table_md2_2b4_d3b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#RT-ResponseTemplate__table_md2_2b4_d3b}  

    new sn_templated_snip.ResponseTemplate().query("incident","ef4225a40a0a0b5700d0b8a790747812", "", 0, 0, true, ""); 

## ResponseTemplate -- Abfrage(Zeichenfolge tableName, Zeichenfolge-Datensatz-ID, Zeichenfolge searchTerm, Zahlenlimit, Zahlenoffset, boolescher Wert inklusive EvaluatedBody, Zeichenfolgenfehlerformat, Objektoptionen) {#ariaid-title3}

Gibt alle Antwortvorlagen aus einer angegebenen Tabelle zurück, die den übergebenen Abfragekriterien entsprechen.
{#RT-query_S_S_S_N_N_B_S_O__table_bq2_kgr_vhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| tableName | Zeichenfolge | Name der Tabelle, die zum Durchsuchen der sn_templated_snip_note_template-Tabelle verwendet werden soll, um die entsprechenden Antwortvorlagen zu finden. Beispiel: Incident oder sn_hr_core_case. |
| recordId | Zeichenfolge | SYS-ID des Datensatzes, der zum Rendern der Variablen in der Antwortvorlage verwendet werden soll. |
| searchTerm | Zeichenfolge | Optional. Text, der zum Filtern der Liste der übereinstimmenden Antwortvorlagen verwendet werden soll. Die Methode führt eine ENTHÄLT-Suche dieses Texts in den Feldern „Name" und „Textkörper" durch und BEGINNT MIT der Suche im Feld „Kurzname". Wenn der Suchbegriff beispielsweise „Absturz" lautet, gibt die Methode eine Antwortvorlage zurück, die den Abfragekriterien entspricht und im Namen oder Textkörper einen Absturz aufweist, oder der Kurzname beginnt mit „Absturz". Antwortvorlagen mit genauen Übereinstimmungen beim Kurznamen werden in den Rückgabeergebnissen zuerst angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Namen sortiert. Standard: Gibt alle übereinstimmenden Antwortvorlagen zurück. |
| limit | Nummer | Optional. Maximale Anzahl zurückzugebender Antwortvorlagen. Standard: 50 |
| Offset | Nummer | Optional. Für Paginierung der Index, bei dem die Suche gestartet werden soll. Standard: 0 |
| EingeschlosseneEvaluiertBody | Boolean | Optional. Kennzeichnung, die angibt, ob die Vorlagenvariablen gerendert werden sollen. Gültige Werte: * Falsch: Die Vorlagenvariablen nicht rendern. Die Antwort enthält die Nachrichtenvariablen. Zum Beispiel: ``` Beachten Sie, dass Ihr Fall ${number} an ${assignment_Group} eskaliert wurde. ``` * Wahr: Rendert die Vorlagenvariablen und gibt zurück evaluated_response In den Rückgabeergebnissen. Zum Beispiel: ``` Beachten Sie, dass Ihr Fall INC100001 an Facilities eskaliert wurde. ``` {#RT-query_S_S_S_N_N_B_S_O__ul_msx_dpx_c3b} Standard: Falsch |
| Fehlerformat | Zeichenfolge | Optional. HTML-Formatierung, die für Fehler verwendet werden soll. Zum Beispiel: `"<span style='color:#ffff00'>${%s}</span>"` Standard: `„ <span style='color:#ff0000'>${%s} </span>„ ` |
| Optionen | Objekt | Optional. Parameter, die an den sn_templated_snip.response_template-Erweiterungspunkt übergeben werden sollen. Format und Inhalt dieser Parameter hängen von der Implementierung des Erweiterungspunkts ab. Weitere Informationen zu Erweiterungspunkten finden Sie unter [Erweiterungspunkte verwenden, um die Anwendungsfunktionalität zu erweitern](https://servicenow-prod.fluidtopics.net/ndSXYeydZ33zccIfdcJLVA "Verwenden Sie Erweiterungspunkte, um die Funktionalität einer Anwendung zu erweitern, ohne den ursprünglichen Anwendungscode zu ändern. Sie können bereits vorhandene Erweiterungspunkte verwenden, die in ausgewählt verfügbar sind Now PlatformAnwendungen oder Sie können Erweiterungspunkte hinzufügen, wenn Sie anwenderdefinierte Anwendungen in Ihrer eigenen Instanz entwickeln."). |
[Tabelle : 2. Parameter]

{#RT-query_S_S_S_N_N_B_S_O__table_bq2_kgr_vhb} {#RT-query_S_S_S_N_N_B_S_O__table_cq2_kgr_vhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Array aller Vorlagen, die den angegebenen Suchkriterien entsprechen. Antwortvorlagen mit genauen Übereinstimmungen beim Kurznamen werden in den Rückgabeergebnissen zuerst angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Namen sortiert. Jeder Knoten im Array kann die folgenden Parameter enthalten: * sys_id: Zeichenfolge. Eindeutiger Bezeichner der Antwortvorlage. * name: Zeichenfolge. Name der Antwortvorlage. * short_name: Zeichenfolge. Kurzname der Antwortvorlage. * body: HTML. Textkörper der Antwortvorlage. * short_name_match: Boolescher Wert. Kennzeichnung, die angibt, ob eine genaue Übereinstimmung mit dem Kurznamen der Antwortvorlage aufgetreten ist. * evaluated_response: Array. Ergebnisse der Vorlagenauswertung. * success: Boolescher Wert. Kennzeichnung, die angibt, ob alle Variablen ordnungsgemäß gerendert werden. * evaluated_body: HTML. Gerenderter Antwortvorlagentext. * error: Array. Eintrag für jeden aufgetretenen Evaluierungsfehler. * inAccessibleVariables: Zeichenfolge. Variablen im Antwortvorlagentext, die nicht aufgelöst werden konnten. * unEvaluatedVariables: Zeichenfolge. Variablen im Antwortvorlagentext, die nicht ausgewertet wurden. * message: Zeichenfolge. Fehlermeldung. {#RT-query_S_S_S_N_N_B_S_O__ul_qlb_bzx_c3b} {#RT-query_S_S_S_N_N_B_S_O__ul_hyc_myx_c3b} {#RT-query_S_S_S_N_N_B_S_O__ul_dcs_nxx_c3b} |
[Tabelle : 3. Rückgaben]

{#RT-query_S_S_S_N_N_B_S_O__table_cq2_kgr_vhb}  
Dieses Beispiel zeigt, wie Antwortvorlagen abgefragt werden, die der Incident-Tabelle zugeordnet sind.

    query("incident","ef4225a40a0a0b5700d0b8a790747812", "", 0, 0, false, "");

Erfolgreiche Antwort:

    [
      {
        "sys_id": "5fc1d65993003300a9bc1d1e867ffb9c",
        "name": "Incident escalation",
        "short_name": "escalation",
        "template_body": "<p>Dear ${caller_id.first_name},</p>\r\n<p>Please note that your incident ${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>\r\n<p>Regards,</p>\r\n<p>${sys_updated_by}</p>"
      }
    ]

Gleiche Abfrage mit einer Fehlerantwort.

    query("incident","fe4225a40a0a0b5700d0b8a790747812", "", 0, 0, false, "");

Fehlerantwort:

    [
      {
        "sys_id": "5fc1d65993003300a9bc1d1e867ffb9c",
        "name": "Incident escalation",
        "short_name": "escalation",
        "template_body": "<p>Dear ${caller.first_name},</p>\r\n<p>Please note that your incident ${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>\r\n<p>Regards,</p>\r\n<p>${sys_updated_by}</p>",
        "evaluated_response": {
          "success": false,
          "error": {
            "unEvaluatedVariables": "caller.first_name",
            "message": "Cannot evaluate following variables: caller.first_name"
          },
          "evaluated_body": "<p>Dear <span style='color:#ff0000'>${caller.first_name}</span>,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. 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>\r\n<p>Regards,</p>\r\n<p>admin</p>"
        }
      }
    ]

## ResponseTemplate -- Rendern (Zeichenfolgenvorlagen-ID, ZeichenfolgentableName, Zeichenfolgen-Datensatz-ID, Zeichenfolgen-Fehlerformat, Objektoptionen) {#ariaid-title4}

Rendert den HTML-Text einer angegebenen Antwortvorlage.
Beim Rendern werden alle Variablen mithilfe der Informationen aus der angegebenen Tabelle und dem angegebenen Datensatz aufgelöst. Wenn Variablen nicht gelöst werden können oder während des Renderings ein anderes Problem auftritt, gibt die Methode eine Fehlermeldung in den Ergebnissen zurück.
{#RT-render_S_S_S_S_O__table_uwn_2fr_vhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| templateId | Zeichenfolge | SYS-ID der zu rendernden Antwortvorlage. |
| tableName | Zeichenfolge | Name der Tabelle, die beim Rendern der Variablen in der Antwortvorlage verwendet werden soll. |
| recordId | Zeichenfolge | SYS-ID des Datensatzes, der beim Rendern der Variablen in der Antwortvorlage verwendet werden soll. Dieser Datensatz muss sich in der von angegebenen Tabelle befinden tableName. |
| Fehlerformat | Zeichenfolge | Optional. HTML-Formatierung, die für Fehler verwendet werden soll. Zum Beispiel: `"<span style='color:#ffff00'>${%s}</span>"` Standard: `„ <span style='color:#ff0000'>${%s} </span>„ ` |
| Optionen | Objekt | Optional. Parameter, die an den sn_templated_snip.response_template-Erweiterungspunkt übergeben werden sollen. Format und Inhalt dieser Parameter hängen von der Implementierung des Erweiterungspunkts ab. Weitere Informationen zu Erweiterungspunkten finden Sie unter [Erweiterungspunkte verwenden, um die Anwendungsfunktionalität zu erweitern](https://servicenow-prod.fluidtopics.net/ndSXYeydZ33zccIfdcJLVA "Verwenden Sie Erweiterungspunkte, um die Funktionalität einer Anwendung zu erweitern, ohne den ursprünglichen Anwendungscode zu ändern. Sie können bereits vorhandene Erweiterungspunkte verwenden, die in ausgewählt verfügbar sind Now PlatformAnwendungen oder Sie können Erweiterungspunkte hinzufügen, wenn Sie anwenderdefinierte Anwendungen in Ihrer eigenen Instanz entwickeln."). |
[Tabelle : 4. Parameter]

{#RT-render_S_S_S_S_O__table_uwn_2fr_vhb} {#RT-render_S_S_S_S_O__table_vwn_2fr_vhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ergebnisse des Renderings. * success: Kennzeichnung, die angibt, ob das Rendern erfolgreich war. * evaluated_body: Zeichenfolge. Für Erfolg wird der Antwortvorlagentext gerendert. Für Fehler: Antwortvorlagentext, der sowohl gerenderte als auch nicht renderbare Variablen enthält. * error: Objekt. Fehlermeldung, wenn das Rendern nicht erfolgreich war. * unEvaluatedVariables: Variablen, die nicht gerendert werden konnten. * message: Fehlermeldung. {#RT-render_S_S_S_S_O__ul_cdl_d14_d3b} {#RT-render_S_S_S_S_O__ul_q1m_d3y_c3b} |
[Tabelle : 5. Rückgaben]

{#RT-render_S_S_S_S_O__table_vwn_2fr_vhb}  
Dieses Codebeispiel zeigt, wie eine gerenderte Antwortvorlage für die Incident-Tabelle angefordert wird.

    render("5fc1d65993003300a9bc1d1e867ffb9c","incident","ef4225a40a0a0b5700d0b8a790747812", "")

Erfolgreiche Antwort:

    {
      "success": true,
      "evaluated_body": "<p>Dear Beth,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. 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>\r\n<p>Regards,</p>\r\n<p>admin</p>"
    }

Gleiche Renderanforderung, aber es wird eine Fehlerantwort zurückgegeben.

    render("5fc1d65993003300a9bc1d1e867ffb9c","incident","ef4225a40a0a0b5700d0b8a790747812", "")

Fehlerantwort:

    {
      "success": false,
      "error": {
        "unEvaluatedVariables": "caller.first_name",
        "message": "Cannot evaluate following variables: caller.first_name"
      },
      "evaluated_body": "<p>Dear <span style='color:#ff0000'>${caller.first_name}</span>,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. 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>\r\n<p>Regards,</p>\r\n<p>admin</p>"
    }


