応答テンプレート API

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：9分

    • 応答テンプレート API は、応答テンプレート [sn_templated_snip_note_template] テーブルのレコードを処理するためのエンドポイントを提供します。

    このスクリプトインクルードには、デフォルトでアクティブ化され、 sn_templated_snip 名前空間内で実行されるテンプレート化された応答プラグイン (com.sn_templated_snip) が必要です。

    応答テンプレートの詳細については、「 応答テンプレート」を参照してください。

    応答テンプレート - POST /response_templates/get_templates

    応答テンプレート [sn_templated_snip_note_template] テーブルからレコードを返します。

    URL 形式

    デフォルトの URL：/api/sn_templated_snip/response_templates/get_templates

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    なし
    表 : 2. クエリパラメータ
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    errorFormat エラーに使用する HTML 書式設定。

    データタイプ：文字列

    デフォルト："<span style='color:#ff0000'>${%s}</span>"
    includeEvaluatedBody テンプレートの変数をレンダリングするかどうかを示すフラグ。

    有効な値：

    • false：テンプレートの変数をレンダリングしない。応答にはメッセージ変数が含まれます。
      例： 
      ケース ${number} が ${assignment_group} にエスカレーションされました。
    • true：テンプレート変数をレンダリングして、結果の中で evaluated_response を返します。
      例： 
      ケース INC100001 が施設にエスカレーションされました。

    データタイプ：ブーリアン

    デフォルト値：false
    limit 返される応答テンプレートの最大数。

    データタイプ：数値

    デフォルト：50
    offset ページネーションの場合は、検索を開始するインデックス。

    データタイプ：数値

    デフォルト：0
    opts sn_templated_snip.response_template 拡張ポイントに渡すパラメーター。これらのパラメーターの形式と内容は、拡張ポイントの実装によって異なります。拡張ポイントの詳細については、「 拡張ポイントを使用してアプリケーション機能を拡張する」を参照してください。

    データタイプ: オブジェクト
    recordId 必須です。応答テンプレートの変数をレンダリングするために使用するレコードの sys_id。

    データタイプ：文字列
    searchTerm 一致する応答テンプレートのリストをフィルタリングするために使用するテキスト。

    このエンドポイントは、名前と本文のフィールドでこのテキストの CONTAINS 検索を実行し、短い名前のフィールドで STARTS WITH 検索を実行します。たとえば、検索用語が「crash」の場合、このエンドポイントは、クエリ条件に一致し、名前または本文に「crash」が含まれているか、短い名前が「crash」で始まる応答テンプレートを返します。

    短い名前が完全に一致する応答テンプレートは、返される結果の最初に表示されます。返された他の応答テンプレートはすべて名前順にソートされます。

    データタイプ：文字列

    デフォルト：一致するすべての応答テンプレートを返します。
    tableName 必須です。応答テンプレートテーブルを検索して対応する応答テンプレートを見つけるために使用するテーブルの名前。たとえば、「incident」や「sn_hr_core_case」などです。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result

    指定された検索条件に一致するすべてのテンプレートをリストするオブジェクトのアレイ。

    データタイプ：アレイ

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

    短い名前が完全に一致する応答テンプレートは、返される結果の最初に表示されます。返された他の応答テンプレートはすべて名前順にソートされます。

    データタイプ：オブジェクト

    {
  "evaluated_response": [Array],
  "name": "String",
  "short_name": "String",
  "short_name_match": Boolean,
  "sys_id": "String",
  "template_body": "String"
}
    result.<object>.evaluated_response

    テンプレート評価の結果をリストするアレイ。

    データタイプ：アレイ

    "elevated_response":[
  "error": [Array],
  "evaluated_body": "String",
  "success": Boolean
]
    result.<object>.evaluated_response.error

    発生した評価エラーそれぞれのエントリのリスト。

    データタイプ：アレイ

    "error":[
  "inAccessibleVariables": "String",
  "message": "String",
  "unEvaluatedVariables": "String"
]
    result.<object>.evaluated_response.error.inAccessibleVariables 解決できなかった応答テンプレート本文内の変数。

    データタイプ：文字列
    result.<object>.evaluated_response.error.message エラーメッセージ。

    データタイプ：文字列
    result.<object>.evaluated_response.error.unEvaluatedVariables 評価されなかった応答テンプレート本文内の変数。

    データタイプ：文字列
    result.<object>.evaluated_response.evaluated_body HTML の評価済み応答テンプレート本文。

    データタイプ：文字列
    result.<object>.evaluated_response.success

    すべての変数が適切にレンダリングされたかどうかを示すフラグ。

    可能な値：
    • true：すべての変数が適切にレンダリングされました。
    • false：変数が適切にレンダリングされませんでした。

    データタイプ：ブーリアン
    result.<object>.name 応答テンプレートの名前。

    データタイプ：文字列
    result.<object>.short_name 応答テンプレートの短い名前。

    データタイプ：文字列
    result.<object>.short_name_match

    応答テンプレートの短い名前が完全に一致したかどうかを示すフラグ。

    可能な値：
    • true：検索用語は完全に一致しています。
    • false：検索用語は完全には一致していません。

    データタイプ：ブーリアン
    result.<object>.sys_id 応答テンプレートの sys_id。

    データタイプ：文字列
    result.<object>.template_body HTML の応答テンプレート本文。

    データタイプ：文字列

    サンプル cURL 要求

    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>"
      }
   ]
}