API des modèles de réponses

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’API Modèles de réponses fournit des points de terminaison pour gérer les enregistrements de la table Modèles de réponses [sn_templated_snip_note_template].

    Cet include de script nécessite le module d’extension Templated Responses (com.sn_templated_snip), qui est activé par défaut, et qui s’exécute dans l’espace de noms sn_templated_snip .

    Pour plus d’informations sur les modèles de réponse, voir Modèles de réponse.

    Modèles de réponses : POST /response_templates/get_templates

    Renvoie les enregistrements de la table Modèles de réponses [sn_templated_snip_note_template].

    Format d'URL

    URL par défaut : /api/sn_templated_snip/response_templates/get_templates

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 2. Paramètres de requête
    Nom Description
    Aucun
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    errorFormat (en anglais seulement) Mise en forme HTML à utiliser pour les erreurs.

    Type de données : chaîne

    Par défaut : « <span style='color:#ff0000'>${%s}</span> »
    includeEvaluatedBody Marqueur indiquant s’il faut afficher les variables de modèle.

    Valeurs valides :

    • faux : n’affiche pas les variables de modèle. La réponse contient les variables de message.
      Par exemple : 
      Veuillez noter que votre ticket ${number} a été escaladé à ${assignment_group}.
    • vrai : affiche les variables de modèle et renvoie les résultats renvoyés evaluated_response .
      Par exemple : 
      Veuillez noter que votre INC100001 de ticket a été remonté aux installations.

    Type de données : booléennes

    Valeur par défaut : false
    limite Nombre maximal de modèles de réponses à renvoyer.

    Type de données : nombre

    Par défaut : 50
    décalage Pour la pagination, index auquel débuter la recherche.

    Type de données : nombre

    Par défaut : 0
    Opte Paramètres à transmettre au point d’extension sn_templated_snip.response_template. Le format et le contenu de ces paramètres dépendent de l’implémentation du point d’extension. Pour plus d’informations sur les points d’extension, consultez Utilisation de points d’extension pour étendre les fonctionnalités de l’application.

    Type de données : objet
    recordId Requis. Sys_id de l’enregistrement à utiliser pour afficher les variables dans le modèle de réponse.

    Type de données : chaîne
    searchTerm Texte à utiliser pour filtrer la liste des modèles de réponse correspondants.

    Le point de terminaison effectue une recherche CONTAINS de ce texte dans les champs nom et corps et une recherche STARTS WITH sur le champ nom court. Par exemple, si le terme de recherche est « crash », le point de terminaison renvoie n’importe quel modèle de réponse qui correspond aux critères de requête et dont le nom ou le corps est marqué d’un crash, ou dont le nom court commence par crash.

    Les modèles de réponse avec des correspondances exactes sur le nom court apparaissent en premier dans les résultats de renvoi. Tous les autres modèles de réponses renvoyés sont triés par nom.

    Type de données : chaîne

    Par défaut : renvoyer tous les modèles de réponse correspondants.
    tableName Requis. Nom de la table à utiliser pour rechercher dans la table Modèles de réponse afin de localiser les modèles de réponse correspondants. Par exemple, « incident » ou « sn_hr_core_case ».

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Content-Type Format de données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de réponse (JSON ou XML)

    Nom Description
    résultat

    Tableau d’objets qui répertorie tous les modèles qui correspondent aux critères de recherche spécifiés.

    Type de données : tableau

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

    Les modèles de réponse avec des correspondances exactes sur le nom court apparaissent en premier dans les résultats de renvoi. Tous les autres modèles de réponses renvoyés sont triés par nom.

    Type de données : objet

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

    Tableau qui répertorie les résultats de l’évaluation du modèle.

    Type de données : tableau

    "elevated_response":[
  "error": [Array],
  "evaluated_body": "String",
  "success": Boolean
]
    résultat.<object>. evaluated_response.erreur

    Liste des entrées pour chaque erreur d’évaluation survenue.

    Type de données : tableau

    "error":[
  "inAccessibleVariables": "String",
  "message": "String",
  "unEvaluatedVariables": "String"
]
    résultat.<object>. evaluated_response.error.inAccessibleVariables Variables dans le corps du modèle de réponse qui n’ont pas pu être résolues.

    Type de données : chaîne
    résultat.<object>. evaluated_response.error.message Message d'erreur.

    Type de données : chaîne
    résultat.<object>. evaluated_response.error.unEvaluatedVariables Variables du corps du modèle de réponse qui n’ont pas été évaluées.

    Type de données : chaîne
    résultat.<object>. evaluated_response.corps_évalué Corps du modèle de réponse évalué en HTML.

    Type de données : chaîne
    résultat.<object>. evaluated_response.réussite

    Marqueur indiquant si toutes les variables se sont rendues correctement.

    Valeurs possibles :
    • vrai : toutes les variables sont restituées correctement.
    • false : les variables ne se sont pas affichées correctement.

    Type de données : booléennes
    résultat.<object>. nom Nom du modèle de réponse.

    Type de données : chaîne
    résultat.<object>. short_name Nom court du modèle de réponse.

    Type de données : chaîne
    résultat.<object>. short_name_match

    Marqueur indiquant si une correspondance exacte s’est produite sur le nom court du modèle de réponse.

    Valeurs possibles :
    • true : le terme recherché est une correspondance exacte.
    • false : le terme recherché n’est pas une correspondance exacte.

    Type de données : booléennes
    résultat.<object>. sys_id Sys_id du modèle de réponse.

    Type de données : chaîne
    résultat.<object>. template_body Corps du modèle de réponse en HTML.

    Type de données : chaîne

    Exemple de demande 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>"
      }
   ]
}