API des modèles de réponses
L’API Modèles de réponse fournit des points de terminaison pour gérer les enregistrements dans la table Modèles de réponse [sn_templated_snip_note_template].
Cette API nécessite le module d’extension Templated Responses (com.sn_templated_snip), qui est activé par défaut. Cette API est fournie dans l’espace de noms sn_templated_snip .
Pour plus d’informations sur les modèles de réponse, consultez 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éponse [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
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Format d’erreur | Formatage HTML à utiliser en cas d’erreur. Type de données : chaîne Valeur par défaut : |
| includeEvaluatedBody | Marqueur indiquant si les variables de modèle doivent être rendues. Valeurs valides :
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émarrer 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éponses correspondants. Le point de terminaison effectue une recherche CONTAINS de ce texte dans les champs nom et corps et une recherche STARTS WITH dans 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 du message indique « crash », ou si le nom court commence par « crash ». Les modèles de réponses avec des correspondances exactes avec le nom court apparaissent en premier dans les résultats renvoyés. Tous les autres modèles de réponse renvoyés sont triés par nom. Type de données : chaîne Par défaut : renvoie tous les modèles de réponse correspondants. |
| tableName | Requis. Nom de la table à utiliser pour rechercher les modèles de réponse correspondants dans la table des modèles de réponse. 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 de 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 |
| Résultat.<object> | Les modèles de réponses avec des correspondances exactes avec le nom court apparaissent en premier dans les résultats renvoyés. Tous les autres modèles de réponse renvoyés sont triés par nom. Type de données : objet |
| résultat.<object>. evaluated_response | Tableau qui répertorie les résultats de l’évaluation du modèle. Type de données : tableau |
| résultat.<object>. evaluated_response.Erreur | Liste des entrées pour chaque erreur d’évaluation qui s’est produite. Type de données : tableau |
| 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 dans le 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.succès | Marqueur indiquant si toutes les variables sont restituées correctement. Valeurs possibles :
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 qui indique si une correspondance exacte s’est produite sur le nom court du modèle de réponse. Valeurs possibles :
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>"
}
]
}