Antwortvorlagen-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Die API für Antwortvorlagen stellt Endpunkte für die Verarbeitung von Datensätzen in der Tabelle „Antwortvorlagen“ [sn_template_snip_note_template] bereit.

    Diese Skripteinbindung erfordert das Plugin „Templated Responses“ (com.sn_template_snip), das standardmäßig aktiviert ist und innerhalb des Namespace sn_template_snip ausgeführt wird.

    Weitere Informationen zu Antwortvorlagen finden Sie unter Antwortvorlagen.

    Antwortvorlagen: POST /response_templates/get_templates

    Gibt Datensätze aus der Tabelle „Antwortvorlagen“ [sn_template_snip_note_template] zurück.

    URL-Format

    Standard-URL: /api/sn_template_snip/response_templates/get_templates

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    FehlerFormat HTML-Formatierung für Fehler.

    Datentyp: Zeichenfolge

    Standard: „<span style='color:#ff0000'>${%s}</span>„
    IncludeEvaluatedBody Kennzeichnung, die angibt, ob die Vorlagenvariablen gerendert werden sollen.

    Gültige Werte:

    • „falsch“: Vorlagenvariablen werden nicht gerendert. Die Antwort enthält die Nachrichtenvariablen.
      Zum Beispiel: 
      Beachten Sie, dass Ihr Fall ${number} zu ${assignment_group} eskaliert wurde.
    • „wahr“: Rendert die Vorlagenvariablen und gibt evaluated_response in den Rückgabeergebnissen zurück.
      Zum Beispiel: 
      Beachten Sie, dass Ihr Fall INC100001 an Facilitys eskaliert wurde.

    Datentyp: Boolesch

    Standardwert: false
    limit Maximale Anzahl der zurückzugebenden Antwortvorlagen.

    Datentyp: Zahl

    Standard: 50
    Offset Bei Paginierung der Index, bei dem die Suche gestartet werden soll.

    Datentyp: Zahl

    Standard: 0
    Opt Parameter, die an den Erweiterungspunkt sn_template_snip.response_template übergeben werden sollen. Format und Inhalt dieser Parameter hängen von der Implementierung des Erweiterungspunkts ab. Weitere Informationen zu Erweiterungspunkten finden Sie unter Erweiterungspunkte zum Erweitern der Anwendungsfunktionalität verwenden.

    Datentyp: Objekt
    recordId Erforderlich. Sys_id des Datensatzes, der zum Rendern der Variablen in der Antwortvorlage verwendet werden soll.

    Datentyp: Zeichenfolge
    searchTerm Text zum Filtern der Liste der übereinstimmenden Antwortvorlagen.

    Der Endpunkt führt für diesen Text in den Feldern „Name“ und „Text“ eine ENTHÄLT-Suche und im Feld „Kurzname“ eine STARTS-MIT-Suche durch. Wenn der Suchbegriff beispielsweise „crash“ lautet, gibt der Endpunkt eine Antwortvorlage zurück, die den Abfragekriterien entspricht und im Namen oder Text „crash“ enthält oder der Kurzname mit „crash“ beginnt.

    Antwortvorlagen mit genauen Übereinstimmungen mit dem Kurznamen werden in den Rückgabeergebnissen zuerst angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Name sortiert.

    Datentyp: Zeichenfolge

    Standard: Gibt alle übereinstimmenden Antwortvorlagen zurück.
    tableName Erforderlich. Name der Tabelle, die zum Durchsuchen der Tabelle „Antwortvorlagen“ nach entsprechenden Antwortvorlagen verwendet werden soll. Beispiel: „Incident“ oder „sn_hr_core_case“.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    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 HTTP-Antwortcodes der REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis

    Array von Objekten, das alle Vorlagen auflistet, die den angegebenen Suchkriterien entsprechen.

    Datentyp: Array

    "result": [
  {Object}
]
    Ergebnis.<object>

    Antwortvorlagen mit genauen Übereinstimmungen mit dem Kurznamen werden in den Rückgabeergebnissen zuerst angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Name 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 Auswertungsfehler.

    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.unEvaluatedVariables 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.success

    Kennzeichnung, die angibt, ob alle Variablen ordnungsgemäß gerendert wurden.

    Mögliche Werte:
    • „true“: Alle Variablen ordnungsgemäß gerendert.
    • „falsch“: Variablen wurden nicht ordnungsgemäß gerendert.

    Datentyp: Boolesch
    Ergebnis.<object>.name Name der Antwortvorlage.

    Datentyp: Zeichenfolge
    Ergebnis.<object>.short_name Kurzer Name der Antwortvorlage.

    Datentyp: Zeichenfolge
    Ergebnis.<object>.short_name_match

    Kennzeichnung, die angibt, ob für den Kurznamen der Antwortvorlage eine genaue Übereinstimmung aufgetreten ist.

    Mögliche Werte:
    • wahr: Suchbegriff ist eine genaue Übereinstimmung.
    • false: Suchbegriff ist keine exakte Übereinstimmung.

    Datentyp: Boolesch
    Ergebnis.<object>.sys_id Sys_id der Antwortvorlage.

    Datentyp: Zeichenfolge
    Ergebnis.<object>.template_body Antwortvorlagentext im HTML-Format.

    Datentyp: Zeichenfolge

    Beispiel für eine 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>"
      }
   ]
}