API ouverte du ticket de problème
L’API Ticket de problème ouvert fournit des points de terminaison pour créer, mettre à jour et récupérer des données à partir des tables Ticket [sn_customerservice_case] et Incident [incident].
Utilisez cette API pour gérer les informations de ticket entre les systèmes de création de tickets externes et le Now Platform.
Cette API est incluse dans l’application Telecommunications Assurance Workflows, disponible à l’adresse .ServiceNow Store Les Service client applications (com.sn_customerservice) et Gestion de la base d’installation du Service clientèle (com.snc.install_base) sont requises pour utiliser cette API avec la table Ticket [sn_customerservice_case].
Cette API est fournie dans l’espace de noms sn_ind_tsm_sdwan .
L’utilisateur appelant doit avoir le rôle ticket_integrator.
Cette API peut être étendue pour effectuer des personnalisations autour des paramètres requis, de la validation du corps de la demande, des opérations REST supplémentaires et des mappages de champs. Pour plus d'informations, voir le Guide du développeur Trouble Ticket Open API.
L’API Trouble Ticket Open est une ServiceNow® implémentation de la spécification REST de l’API TM Forum Trouble Ticket Management. Cette implémentation est basée sur la spécification REST de l’API TMF621 Trouble Ticket Management version 19, juin 2019. L’API Trouble Ticket Open est certifiée par TM Forum.
Ticket de problème : GET /sn_ind_tsm_sdwan/ticket/troubleTicket
Récupère une liste de tous les enregistrements de tickets d’incident à partir des tables Ticket [sn_customerservice_case] et Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/ticket/troubleTicket
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides :
Par défaut : renvoie tous les champs. Type de données : chaîne |
| id | Filtrer les tickets d’incident par sys_id. Seuls les tickets avec les sys_id spécifiés sont renvoyés dans la réponse. Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Par défaut : 25 Maximum : 100 Vous pouvez modifier les valeurs par défaut et maximales en mettant à jour les sn_ind_tsm_sdwan.pagination.set_limit propriétés système et sn_ind_tsm_sdwan.pagination.max_limit . Type de données : nombre |
| décalage | Index de début auquel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Type de données : nombre Par défaut : 0 |
| severity | Filtrez les tickets d’incident par gravité. Seuls les tickets avec la gravité spécifiée sont renvoyés dans la réponse. Type de données : chaîne |
| statut | Filtrez les tickets d’incident par état. Seuls les tickets ayant l’état spécifié sont renvoyés dans la réponse. Type de données : chaîne |
| ticketType | Filtrez les tickets d’incident par type de ticket. Seuls les tickets du type spécifié sont renvoyés dans la réponse. Valeurs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
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.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Plage de contenu | Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si |
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| un lien | Contient les liens suivants pour parcourir les résultats de la requête.
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. |
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.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle retournée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappe le champ Canal [contact_type] pour les tickets et le champ Type de contact [contact_type] pour les incidents. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement du ticket ou de l’incident. Mappé au champ Créé . Type de données : chaîne |
| description | Description du problème à partir du ticket. Mappé au champ Description . Type de données : chaîne |
| href | Lien relatif vers l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| id | sys_id de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement. Mappé au champ Mis à jour . Type de données : chaîne |
| nom | Nom du ticket d’incident, généralement une brève description du problème. Mappé au champ Brève description . Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Nom de l’utilisateur ServiceNow d’intégration qui a effectué la demande POST ou PATCH qui a créé le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Les sys_id peuvent provenir des tables suivantes en fonction du type de ticket et du type de partie associée. Ticket :
Incident :
Ticket ou incident :
Type de données : chaîne |
| relatedParty.name | Nom de la partie liée. Type de données : chaîne |
| relatedParty.@referredType | Type de partie liée. Valeurs possibles :
Type de données : chaîne |
| severity | La gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité . Type de données : chaîne |
| statut | L’état actuel du ticket d’incident. Mappé au champ État . Type de données : chaîne |
| ticketType | Type de ticket. Valeurs possibles :
Type de données : chaîne |
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
Demande cURL
Cet exemple renvoie des champs spécifiés pour les cinq premiers enregistrements de tickets de ticket de problème.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'Corps de la réponse.
[
{
"id": "0004609eb9830110f877b3758cd21d37",
"name": "Compliant Over 2796",
"description": "checkNo2796",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "000560d2b9c30110f877b3758cd21d36",
"name": "Compliant Over 4696",
"description": "checkNo4696",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d34",
"name": "Compliant Over 8817",
"description": "checkNo8817",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d39",
"name": "Compliant Over 8819",
"description": "checkNo8819",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
},
{
"id": "0007ac5eb9c30110f877b3758cd21d3e",
"name": "Compliant Over 8821",
"description": "checkNo8821",
"status": "New",
"severity": "3 - Moderate",
"ticketType": "Case"
}
]Ticket de problème : GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
Récupère un enregistrement spécifié de la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Sys_id de l’enregistrement du ticket ou de l’incident à récupérer. Type de données : chaîne Table : Ticket [sn_customerservice_case] ou Incident [incident] |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Valeurs valides :
Type de données : chaîne Par défaut : renvoie tous les champs. |
| Nom | Description |
|---|---|
| Néant |
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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. 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 la 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. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
| 404 | Enregistrement introuvable. Un enregistrement associé à l’ID n’a pas été trouvé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement du ticket ou de l’incident. Mappé au champ Créé. Type de données : chaîne |
| description | Description du problème à partir du ticket. Mappé au champ Description. Type de données : chaîne |
| href | Lien relatif vers l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| id | Sys_id de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement. Mappé au champ Mis à jour. Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau d’objets |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Nom de l’utilisateur qui a écrit le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Les sys_id peuvent provenir des tables suivantes en fonction du type de ticket et du type de partie associée. Ticket :
Incident :
Ticket ou incident :
Type de données : chaîne |
| relatedParty.name | Nom de la partie liée. Type de données : chaîne |
| relatedParty.@referredType | Type de partie liée. Valeurs possibles :
Type de données : chaîne |
| severity | Gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité. Type de données : chaîne |
| statut | État actuel du ticket de problème. Mappé au champ État. Type de données : chaîne |
| ticketType | Type de ticket. Valeurs possibles :
Type de données : chaîne |
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
Demande cURL
Cet exemple récupère un enregistrement de ticket d’incident à partir de la table Ticket [sn_customerservice_case].
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"id": "370415f03c20e910f8772f1bc332b31b",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
"creationDate": "2023-01-19 22:39:28",
"lastUpdate": "2023-01-19 22:41:39",
"description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
"severity": "2 - High",
"ticketType": "Case",
"name": "My router is not working properly",
"status": "Open",
"channel": {
"name": "e_bonding"
},
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@referredType": "customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "b7fa12c7532520103b6bddeeff7b123b",
"href": "",
"name": "Deduplication and Compression PRD00001965",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "71e73d87c3e23010ff00ed23a140dde8",
"href": "",
"name": "",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
},
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:41:39",
"author": "System Administrator",
"@type": "comments"
},
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:39:28",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}Ticket de problème : GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
Récupère un enregistrement spécifié de la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| ticketType | Type de ticket. Cette valeur détermine si un enregistrement est récupéré à partir de la table Ticket [sn_customerservice_case] ou Incident [incident]. Valeurs valides :
Type de données : chaîne |
| id | Sys_id de l’enregistrement du ticket ou de l’incident à récupérer. Type de données : chaîne |
| Nom | Description |
|---|---|
| champs | Liste des champs séparés par des virgules à envoyer dans la réponse. Les champs non valides sont ignorés. Si cette valeur n’est pas transmise, tous les champs sont renvoyés. Champs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. 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 la 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. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
| 404 | Enregistrement introuvable. Un enregistrement associé à l’ID n’a pas été trouvé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement du ticket ou de l’incident. Mappé au champ Créé. Type de données : chaîne |
| description | Description du problème à partir du ticket. Mappé au champ Description. Type de données : chaîne |
| id | Sys_id de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement. Mappé au champ Mis à jour. Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau d’objets |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Nom de l’utilisateur ServiceNow d’intégration qui a effectué la demande POST ou PATCH qui a créé le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les sociétés et les contacts associés au ticket. Type de données : tableau d’objets |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| relatedParty.name | Nom de la partie liée. Pour les tickets, mappé au champ Contact ou Compte. Pour les incidents, mappé au champ Appelant ou Société. Type de données : chaîne |
| severity | Gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité. Type de données : chaîne |
| statut | État actuel du ticket de problème. Mappe au champ. Type de données : chaîne |
| ticketType | Type de ticket (ticket ou incident). Type de données : chaîne |
Demande cURL
Cet exemple permet d’obtenir le nom, la description, la gravité et l’état d’un ticket.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"name": "Short description of issue",
"description": "Example description of an issue",
"severity": "2 - High",
"status": "Open"
}Ticket de problème : PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
Met à jour un enregistrement spécifié dans la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Sys_id de l’enregistrement du ticket ou de l’incident à mettre à jour. Type de données : chaîne Table : Ticket [sn_customerservice_case] ou Incident [incident] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Les valeurs valides sont les choix pour le champ contact_type. Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne |
| description | Description du problème. Mappé au champ Description . Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste des notes de travail et des commentaires à ajouter au ticket. Type de données : tableau d’objets |
| note.@type | Type de note. Cette valeur détermine si la note est enregistrée dans le champ Notes de travail ou Commentaires supplémentaires. Valeurs valides :
Type de données : chaîne |
| note.text | Texte de la note. Mappé au champ Notes de travail ou Commentaires supplémentaires. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Pour les tickets, ce paramètre remplit le champ Contact ou Compte. Pour les incidents, ce paramètre renseigne le champ Appelant ou Société. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| severity | Gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité . Valeurs valides :
1. Si une valeur non valide est fournie, la gravité est définie sur Faible.Type de données : chaîne |
| statut | État actuel du ticket de problème. Mappé au champ État . Les valeurs valides sont les choix pour le champ État . Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, 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.
| 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 la 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. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
| 404 | Enregistrement introuvable. Un enregistrement associé à l’ID n’a pas été trouvé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement. Type de données : chaîne |
| description | Description du problème à partir du ticket. Type de données : chaîne |
| href | Lien relatif vers l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| id | Sys_id de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement. Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau d’objets |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Nom de l’utilisateur qui a écrit le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Les sys_id peuvent provenir des tables suivantes en fonction du type de ticket et du type de partie associée. Ticket :
Incident :
Ticket ou incident :
Type de données : chaîne |
| relatedParty.name | Nom de la partie liée. Type de données : chaîne |
| relatedParty.@referredType | Type de partie liée. Valeurs possibles :
Type de données : chaîne |
| severity | Gravité du problème décrit par le ticket d’incident. Type de données : chaîne |
| statut | État actuel du ticket de problème. Type de données : chaîne |
| ticketType | Type de ticket. Valeurs possibles :
Type de données : chaîne |
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
Demande cURL
Cet exemple met à jour un enregistrement de ticket.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
description: "Updated description",
"note": [
{
"text": "Adding another comment",
"@type": "comments"
}
]
}" \
--user 'username':'password'Corps de la réponse.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:48:42",
"description": "Updated description",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Adding another comment",
"date": "2022-05-16 16:48:42",
"author": "admin",
"@type": "comments"
},
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}Ticket de problème : PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
Met à jour un enregistrement dans la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| ticketType | Type de ticket. Cette valeur détermine si un enregistrement est mis à jour dans la table Ticket [sn_customerservice_case] ou Incident [incident]. Valeurs valides :
Type de données : chaîne |
| id | Sys_id de l’enregistrement du ticket ou de l’incident à mettre à jour. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Les valeurs valides sont les choix pour le champ contact_type. Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne |
| description | Description du problème. Mappé au champ Description . Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste des notes de travail et des commentaires à ajouter au ticket. Type de données : tableau d’objets |
| note.@type | Type de note. Cette valeur détermine si la note est enregistrée dans le champ Notes de travail ou Commentaires supplémentaires. Valeurs valides :
Type de données : chaîne |
| note.text | Texte de la note. Mappé au champ Notes de travail ou Commentaires supplémentaires. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Pour les tickets, ce paramètre remplit le champ Contact ou Compte. Pour les incidents, ce paramètre renseigne le champ Appelant ou Société. Type de données : tableau d’objets |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| severity | Gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité . Valeurs valides :
1. Si une valeur non valide est fournie, la gravité est définie sur Faible.Type de données : chaîne |
| statut | État actuel du ticket de problème. Mappé au champ État. Les valeurs valides sont les choix pour le champ État. Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, 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.
| 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 la 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. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
| 404 | Enregistrement introuvable. Un enregistrement associé à l’ID n’a pas été trouvé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement. Type de données : chaîne |
| description | Description du problème à partir du ticket. Type de données : chaîne |
| id | sys_id de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement. Type de données : chaîne |
| nom | Nom du ticket d’incident, généralement une brève description du problème. Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Nom de l’utilisateur d’intégration ServiceNow qui a effectué la demande POST ou PATCH ayant créé le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow. Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les sociétés et les contacts associés au ticket. Type de données : tableau |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| relatedParty.name | Le nom de la partie liée. Type de données : chaîne |
| severity | La gravité du problème décrit par le ticket d’incident. Type de données : chaîne |
| statut | L’état actuel du ticket d’incident. Type de données : chaîne |
| ticketType | Type de ticket (ticket ou incident). Type de données : chaîne |
Demande cURL
Cet exemple met à jour un enregistrement de ticket.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
\"name\":\"My router is not working properly\",
\"severity\":\"2\",
\"status\":\"10\",
\"ticketType\":\"Case\",
\"channel\":{
\"id\":\"8774\",
\"name\":\"eBonding\",
\"@type\":\"Channel\"
},
\"note\":[
{
\"id\":\"77456\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:34:45.968Z\",
\"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
\"@type\":\"Worknotes\"
},
{
\"id\":\"77457\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:35:45.968Z\",
\"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
\"@type\":\"Comment\"
}
],
\"relatedParty\":[
{
\"id\":\"eaf68911c35420105252716b7d40ddde\",
\"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
\"name\":\"Sally Thomas\",
\"role\":\"customer\",
\"@referredType\":\"customer_contact\"
},
{
\"id\":\"ffc68911c35420105252716b7d40dd55\",
\"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
\"name\":\"Funco Intl\",
\"role\":\"customer\",
\"@referredType\":\"customer\"
}
],
\"relatedEntity\": [
{
\"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"product\"
},
{
\"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"asset\"
},
{
\"id\": \"a1913c3577b301108e191e599a5a99e8\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"product_inventory\"
}
]
}" \
--user 'username':'password'Corps de la réponse.
{
"id": "370415f03c20e910f8772f1bc332b31b",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
"creationDate": "2023-01-19 22:39:28",
"lastUpdate": "2023-01-19 22:41:39",
"description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
"severity": "2 - High",
"ticketType": "Case",
"name": "My router is not working properly",
"status": "Open",
"channel": {
"name": "e_bonding"
},
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@referredType": "customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "b7fa12c7532520103b6bddeeff7b123b",
"href": "",
"name": "Deduplication and Compression PRD00001965",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "71e73d87c3e23010ff00ed23a140dde8",
"href": "",
"name": "",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
},
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:41:39",
"author": "System Administrator",
"@type": "comments"
},
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 14:39:28",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}Ticket de problème : POST /sn_ind_tsm_sdwan/ticket/troubleTicket
Crée un enregistrement dans la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/ticket/troubleTicket
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Les valeurs valides sont les choix pour le champ contact_type. Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne |
| description | Requis. Description du problème. Mappé au champ Description . Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste des notes de travail et des commentaires à ajouter au ticket. Type de données : tableau d’objets |
| note.@type | Type de note. Cette valeur détermine si la note est enregistrée dans le champ Notes de travail ou Commentaires supplémentaires. Valeurs valides :
Type de données : chaîne |
| note.text | Texte de la note. Mappé au champ Notes de travail ou Commentaires supplémentaires. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Pour les tickets, ce paramètre remplit le champ Contact ou Compte. Pour les incidents, ce paramètre renseigne le champ Appelant ou Société. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| severity | Requis. La gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité . Valeurs valides :
1. Si une valeur non valide est fournie, la gravité est définie sur Faible.Type de données : chaîne |
| statut | Requis. L’état actuel du ticket d’incident. Mappé au champ État . Les valeurs valides sont les choix pour le champ État . Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne |
| ticketType | Type de ticket. Cette valeur détermine si l’enregistrement est créé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. Valeurs valides :
Type de données : chaîne Par défaut : incident |
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.
| 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 la 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 |
|---|---|
| 201 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| description | Description du problème à partir du ticket. Type de données : chaîne |
| href | Lien relatif vers l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| id | Le sys_id de l’enregistrement de ticket ou d’incident qui a été créé. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| nom | Nom du ticket d’incident, généralement une brève description du problème. Type de données : chaîne |
| note | Liste de tous les commentaires sur le ticket. Cette liste n’inclut pas les notes de travail. Type de données : tableau |
| note.@type | Type de note. Seuls les commentaires sont renvoyés (pas les notes de travail), cette valeur est donc toujours des commentaires.Type de données : chaîne |
| note.auteur | Le nom de l’utilisateur qui a écrit le commentaire. Type de données : chaîne |
| note.date | Date à laquelle le commentaire a été créé dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte du commentaire. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Les sys_id peuvent provenir des tables suivantes en fonction du type de ticket et du type de partie associée. Ticket :
Incident :
Ticket ou incident :
Type de données : chaîne |
| relatedParty.name | Nom de la partie liée. Type de données : chaîne |
| relatedParty.@referredType | Type de partie liée. Valeurs possibles :
Type de données : chaîne |
| severity | La gravité du problème décrit par le ticket d’incident. Type de données : chaîne |
| statut | L’état actuel du ticket d’incident. Type de données : chaîne |
| ticketType | Type de ticket. Valeurs possibles :
Type de données : chaîne |
Demande cURL
Cet exemple crée un enregistrement de ticket de ticket de problème.
curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"name": "Laptop problem",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2",
"status": "New",
"ticketType": "Case",
"channel": {
"name": "Web"
},
"note": [
{
"text": "Work note about this case",
"@type": "work_notes"
},
{
"text": "Comment about this case",
"@type": "comments"
}
],
"relatedEntity": [
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"@referredType": "asset"
}
],
"relatedParty": [
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"@referredType": "customer_contact"
}
]
}" \
--user 'username':'password'Corps de la réponse.
{
"id": "6467508d47e345508761b955d36d43f6",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
"creationDate": "2022-05-16 23:38:55",
"lastUpdate": "2022-05-16 23:38:55",
"description": "Laptop keeps shutting off unexpectedly",
"severity": "2 - High",
"ticketType": "Case",
"name": "Laptop problem",
"status": "New",
"channel": {
"name": "web"
},
"relatedParty": [
{
"id": "",
"name": "",
"@referredType": "customer"
},
{
"id": "62826bf03710200044e0bfc8bcbe5df1",
"name": "",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "",
"href": "",
"name": "",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
"href": "",
"name": "P1000597 - Apple MacBook Pro 15\"",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
}
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "Comment about this case",
"date": "2022-05-16 16:38:55",
"author": "admin",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}Ticket de problème : POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}
Crée un enregistrement dans la table Ticket [sn_customerservice_case] ou Incident [incident].
Format d'URL
URL par défaut : /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| ticketType | Type de ticket. Cette valeur détermine si l’enregistrement est créé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. Valeurs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Mappé au champ Canal [contact_type] pour les tickets et au champ Type de contact [contact_type] pour les incidents. Les valeurs valides sont les choix pour le champ contact_type. Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne |
| description | Requis. Description du problème. Mappé au champ Description . Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Mappé au champ Brève description. Type de données : chaîne |
| note | Liste des notes de travail et des commentaires à ajouter au ticket. Type de données : tableau d’objets |
| note.@type | Type de note. Cette valeur détermine si la note est enregistrée dans le champ Notes de travail ou Commentaires supplémentaires. Valeurs valides :
Type de données : chaîne |
| note.text | Texte de la note. Mappé au champ Notes de travail ou Commentaires supplémentaires. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| Fête connexe | Détails sur les contacts pour le ticket. Pour les tickets, ce paramètre remplit le champ Contact ou Compte. Pour les incidents, ce paramètre renseigne le champ Appelant ou Société. Type de données : tableau d’objets |
| relatedParty.@referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| severity | Requis. Gravité du problème décrit par le ticket d’incident. Mappé au champ Priorité . Valeurs valides :
1. Si une valeur non valide est fournie, la gravité est définie sur Faible.Type de données : chaîne |
| statut | État actuel du ticket de problème. Mappé au champ État . Les valeurs valides sont les choix pour le champ État . Vous pouvez fournir l’étiquette ou la valeur du choix. Par exemple, Type de données : chaîne Par défaut : nouveau |
| ticketType | Requis. Type de ticket. Cette valeur détermine si l’enregistrement est créé dans la table Ticket [sn_customerservice_case] ou Incident [incident]. Valeurs valides :
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.
| 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 la 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 |
|---|---|
| 201 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| @type | Cette valeur est toujours TroubleTicket.Type de données : chaîne |
| canal | Méthode de contact via laquelle le ticket a été créé. Type de données : objet |
| channel.name | Nom de la méthode de contact. Type de données : chaîne |
| creationDate | Date de création de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| description | Description du problème à partir du ticket. Type de données : chaîne |
| id | Sys_id de l’enregistrement de ticket ou d’incident qui a été créé. Type de données : chaîne |
| lastUpdate | Date de dernière mise à jour de l’enregistrement du ticket ou de l’incident. Type de données : chaîne |
| nom | Nom du ticket de problème, généralement une brève description du problème. Type de données : chaîne |
| note | Liste des commentaires et des notes de travail qui ont été ajoutés au ticket par la demande POST. Type de données : tableau d’objets |
| note.@type | Type de note. Valeurs valides :
Type de données : chaîne |
| note.auteur | Nom de l’utilisateur ServiceNow d’intégration qui a effectué la demande POST qui a créé la note. Type de données : chaîne |
| note.date | Date à laquelle la note a été créée dans l’instance ServiceNow . Type de données : chaîne |
| note.text | Texte de la note. Type de données : chaîne |
| Entité connexe | Liste des actifs, produits, produits vendus (inventaire des produits), éléments de configuration ou services impactés. Type de données : tableau d’objets |
| relatedEntity.id | Sys_id de l’élément ou du service impacté. Pour les tickets, cette valeur provient de l’une des tables suivantes :
Type de données : chaîne |
| relatedEntity.href | Renvoie une chaîne vide. Type de données : chaîne |
| relatedEntity.name | Nom de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.role | Description de l’élément ou du service impacté. Type de données : chaîne |
| relatedEntity.@referredType | Type d’élément ou de service. Valeurs valides pour les tickets de tickets :
Valeurs valides pour les tickets d’incident :
Type de données : chaîne |
| relatedEntity.@type | Cette valeur est toujours relatedEntity.Type de données : chaîne |
| Fête connexe | Détails sur les sociétés et les contacts associés au ticket. Type de données : tableau d’objets |
| relatedParty.id | Sys_id de la partie liée. Si vous fournissez un contact ou un utilisateur (appelant), son compte ou sa société est automatiquement renseigné sur le ticket. Type de données : chaîne Table : pour les tickets, le sys_id provient des tables Contact [customer_contact] ou Compte [customer_account]. Pour les incidents, le sys_id provient des tables Utilisateur [sys_user] ou Société [core_company]. |
| relatedParty.referredType | Type de partie liée. Valeurs valides :
Type de données : chaîne |
| severity | Gravité du problème décrit par le ticket d’incident. Type de données : chaîne |
| statut | État actuel du ticket de problème. Type de données : chaîne |
| ticketType | Type de ticket (ticket ou incident). Type de données : chaîne |
Demande cURL
Cet exemple crée un ticket avec une priorité élevée et un état ouvert.
ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
\"name\":\"My router is not working properly\",
\"severity\":\"2\",
\"status\":\"10\",
\"ticketType\":\"Case\",
\"channel\":{
\"id\":\"8774\",
\"name\":\"eBonding\",
\"@type\":\"Channel\"
},
\"note\":[
{
\"id\":\"77456\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:34:45.968Z\",
\"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
\"@type\":\"Worknotes\"
},
{
\"id\":\"77457\",
\"author\":\"Jack Smith\",
\"date\":\"2019-05-31T07:35:45.968Z\",
\"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
\"@type\":\"Comment\"
}
],
\"relatedParty\":[
{
\"id\":\"eaf68911c35420105252716b7d40ddde\",
\"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
\"name\":\"Sally Thomas\",
\"role\":\"customer\",
\"@referredType\":\"customer_contact\"
},
{
\"id\":\"ffc68911c35420105252716b7d40dd55\",
\"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
\"name\":\"Funco Intl\",
\"role\":\"customer\",
\"@referredType\":\"customer\"
}
],
\"relatedEntity\": [
{
\"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"product\"
},
{
\"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"asset\"
},
{
\"id\": \"a1913c3577b301108e191e599a5a99e8\",
\"href\": \"www.google.com\",
\"name\": \"Some random name\",
\"role\": \"I dont know what this is\",
\"@type\": \"relatedEntity\",
\"@referredType\": \"product_inventory\"
}
]
}" \
--user 'username':'password'Corps de la réponse.
{
"id": "5bbb5cbc3c2ca910f8772f1bc332b34d",
"href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/5bbb5cbc3c2ca910f8772f1bc332b34d",
"creationDate": "2023-01-19 18:33:24",
"lastUpdate": "2023-01-19 18:33:24",
"description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
"severity": "2 - High",
"ticketType": "Case",
"name": "My router is not working properly",
"status": "Open",
"channel": {
"name": "e_bonding"
},
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@referredType": "customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@referredType": "customer_contact"
},
{
"id": "",
"name": "",
"@referredType": "assignment_group"
},
{
"id": "",
"name": "",
"@referredType": "assigned_to"
}
],
"relatedEntity": [
{
"id": "b7fa12c7532520103b6bddeeff7b123b",
"href": "",
"name": "Deduplication and Compression PRD00001965",
"role": "This is the product associated with the case.",
"@type": "relatedEntity",
"@referredType": "product"
},
{
"id": "71e73d87c3e23010ff00ed23a140dde8",
"href": "",
"name": "",
"role": "This is the asset associated with the case.",
"@type": "relatedEntity",
"@referredType": "asset"
},
{
"id": "a1913c3577b301108e191e599a5a99e8",
"href": "",
"name": "Deduplication and Compression PI0000037",
"role": "This is the product inventory associated with the case.",
"@type": "relatedEntity",
"@referredType": "product_inventory"
}
],
"note": [
{
"text": "This is a testing comment<script>gs.info('Hello World')</script>",
"date": "2023-01-19 10:33:24",
"author": "System Administrator",
"@type": "comments"
}
],
"@type": "TroubleTicket"
}