---
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


---

# Antwortvorlagen-API

# Antwortvorlagen-API {#ariaid-title1}

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

Die Antwortvorlagen API stellt Endpunkte zur Verarbeitung von Datensätzen in der Tabelle „Antwortvorlagen" \[sn_templated_snip_note_template\] bereit.
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).

## Antwortvorlagen -- POST /response_Templates/get_Templates {#ariaid-title2}

Gibt Datensätze aus der Tabelle „Antwortvorlagen" \[sn_templated_snip_note_template\] zurück.

### URL-Format {#response_temp-POST-get_templates__section_nz2_qyp_3mb}

Standard-URL: /api/sn_templates_snip/response_Templates/get_Templates

### Unterstützte Anforderungsparameter

{#response_temp-POST-get_templates__entry__2}

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

{#response_temp-POST-get_templates__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#response_temp-POST-get_templates__entry__10}

| Name | Beschreibung |
|-|-|
| Fehlerformat | HTML-Formatierung, die für Fehler verwendet werden soll. Datentyp: Zeichenfolge Standard: `„ <span style='color:#ff0000'>${%s} </span>„ ` |
| EingeschlosseneEvaluiertBody | 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_responseIn den Rückgabeergebnissen. Zum Beispiel: ``` Beachten Sie, dass Ihr Fall INC100001 an Facilities eskaliert wurde. ``` {#response_temp-POST-get_templates__ul_esl_jh4_ylb} Datentyp: Boolescher Wert Standard: Falsch |
| limit | Maximale Anzahl zurückzugebender Antwortvorlagen. Datentyp: Zahl Standard: 50 |
| Offset | Für Paginierung der Index, bei dem die Suche gestartet werden soll. Datentyp: Zahl Standard: 0 |
| Optionen | 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."). Datentyp: Objekt |
| recordId | Erforderlich. SYS_ID des Datensatzes, der zum Rendern der Variablen in der Antwortvorlage verwendet werden soll. Datentyp: Zeichenfolge |
| searchTerm | Text, der zum Filtern der Liste der übereinstimmenden Antwortvorlagen verwendet werden soll. Der Endpunkt 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 der Endpunkt 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. Datentyp: Zeichenfolge Standard: Gibt alle übereinstimmenden Antwortvorlagen zurück. |
| tableName | Erforderlich. Name der Tabelle, die zum Durchsuchen der Tabelle „Antwortvorlagen" verwendet werden soll, um entsprechende Antwortvorlagen zu finden. Beispiel: „Incident" oder „sn_hr_core_case". Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#response_temp-POST-get_templates__entry__28}{#response_temp-POST-get_templates__accept-JSON-only-entry-RESTAPI}{#response_temp-POST-get_templates__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#response_temp-POST-get_templates__entry__34}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#response_temp-POST-get_templates__entry__38}{#response_temp-POST-get_templates__entry-200-status-code}{#response_temp-POST-get_templates__entry-401-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#response_temp-POST-get_templates__entry__46}

| Name | Beschreibung |
|-|-|
| Ergebnis | Array von Objekten, die alle Vorlagen auflisten, die den angegebenen Suchkriterien entsprechen. Datentyp: Array "result": [ {Object} ] |
| Ergebnis.\<object\> | Antwortvorlagen mit genauen Übereinstimmungen beim Kurznamen werden in den Rückgabeergebnissen zuerst angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Namen sortiert. Datentyp: Objekt { "evaluated_response": [Array], "name": "String", "short_name": "String", "short_name_match": Boolean, "sys_id": "String", "template_body": "String" } |
| Ergebnis. \<object\>.Evaluated_response | Array, das die Ergebnisse der Vorlagenauswertung auflistet. Datentyp: Array "elevated_response":[ "error": [Array], "evaluated_body": "String", "success": Boolean ] |
| Ergebnis. \<object\>.Evaluated_response.error | Liste der Einträge für jeden aufgetretenen Evaluierungsfehler. Datentyp: Array "error":[ "inAccessibleVariables": "String", "message": "String", "unEvaluatedVariables": "String" ] |
| Ergebnis. \<object\>.evaluated_response.error.inAccessibleVariables | Variablen im Antwortvorlagentext, die nicht aufgelöst werden konnten. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Evaluated_response.error.message | Fehlermeldung. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Evaluated_response.error.unEvaluatedVariablen | Variablen im Antwortvorlagentext, die nicht ausgewertet wurden. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Evaluated_response.Evaluated_body | Ausgewerteter Antwortvorlagentext in HTML. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Evaluated_response.Erfolg | Kennzeichnung, die angibt, ob alle Variablen ordnungsgemäß gerendert werden. Mögliche Werte: * Wahr: Alle Variablen ordnungsgemäß gerendert. * Falsch: Variablen wurden nicht ordnungsgemäß gerendert. {#response_temp-POST-get_templates__ul_wvc_d5s_xlb} Datentyp: Boolescher Wert |
| Ergebnis. \<object\>.Name | Name der Antwortvorlage. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Short_Name | Kurzname der Antwortvorlage. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Short_Name_match | Kennzeichnung, die angibt, ob eine genaue Übereinstimmung mit dem Kurznamen der Antwortvorlage aufgetreten ist. Mögliche Werte: * Wahr: Suchbegriff ist eine genaue Übereinstimmung. * Falsch: Suchbegriff ist keine genaue Übereinstimmung. {#response_temp-POST-get_templates__ul_yby_5ts_xlb} Datentyp: Boolescher Wert |
| Ergebnis. \<object\>.Sys_ID | SYS_ID der Antwortvorlage. Datentyp: Zeichenfolge |
| Ergebnis. \<object\>.Template_body | Antwortvorlagentext in HTML. Datentyp: Zeichenfolge |
[ ]

### Beispiel für Curl-Anforderung

    curl "https://instance.service-now.com/api/sn_templated_snip/response_templates/get_templates" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"tableName\": \"sn_hr_core_case_total_rewards\",
      \"recordId\": \"2c9e43320b30220097432da0d5673a9c\"
    }" \
    --user "username":"password"

    {
       "result": [
          {
             "sys_id": "2552c4ec0b03320036e62c7885673a5a",
             "name": "Escalation Notes - Total Rewards",
             "short_name": "Escalation Notes - Total Rewards",
             "template_body": "<p>Dear ${subject_person},<\/p>\n<p>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<p>Regards,<\/p>\n<p>${sys_updated_by}<\/p>"
          },
          {
             "sys_id": "698388ec0b03320036e62c7885673ab5",
             "name": "Resolution Notes - Phone Inquiry",
             "short_name": "Resolution Notes - Phone Inquiry",
             "template_body": "<p>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<p>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<p>Regards,<\/p>\n<p>${assigned_to}<\/p>"
          }
       ]
    }


