ServiceNow® Les API vous permettent de créer des applications et des expériences personnalisées. Les API ont été améliorées et mises à jour dans la Zurich version.
Points forts de l’API pour la Zurich version
- Utilisez les API JavaScript côté serveur dans les scripts pour modifier les fonctionnalités de l’application.
- Exécutez les API clientes chaque fois qu’un événement lié au client se produit, par exemple lors du chargement d’un formulaire, de l’envoi d’un formulaire ou du changement d’une valeur de champ.
- Utilisez les API REST entrantes pour interagir avec diverses ServiceNow fonctionnalités au sein de votre application.
- Les API client Next Experience incluent des API clientes compatibles avec l’interface utilisateur Next Experience.
Consultez API implementation and reference pour plus d'informations.
Nouveautés de la version Zurich
Tableau 1. Nouvelles classes incluses dans le périmètre et méthodes supplémentaires aux classes incluses dans le périmètre existantes dans Zurich
| Classe |
Méthodes |
| GlideCurrencyCode - Scoped, Global |
- getCurrencyCode()
- getNumericCurrencyCode()
|
| GlideCurrencySymbol - Scoped, Global |
- getCurrencySymbol()
- getSortedActiveCurrencySymbols()
|
| GlideRecord - Scoped |
addUserQuery() |
| GlideSysAttachment - Scoped |
- addAttribute()
- addMultipleAttributes()
- deleteAllAttributes()
- deleteAttribute()
- fetchAllAttributes()
- fetchAttribute()
- updateAllAttributes()
- updateAttribute()
|
| GlideSystem - Scoped |
Ajout de la prise en charge de types de messages supplémentaires à afficher en haut des formulaires :
- addHighMessage()
- addLowMessage()
- addSuccessMessage()
- addModerateMessage()
|
Tableau 2. Nouvelles classes globales et méthodes supplémentaires aux classes globales existantes dans Zurich
| Classe |
Méthodes |
| GlideRecord - Global |
addUserQuery() |
| GlideSysAttachment - Global |
- addAttribute()
- addMultipleAttributes()
- deleteAllAttributes()
- deleteAttribute()
- fetchAllAttributes()
- fetchAttribute()
- updateAllAttributes()
- updateAttribute()
|
| GlideSystem - Global |
Ajout de la prise en charge de types de messages supplémentaires à afficher en haut des formulaires :
- addHighMessage()
- addLowMessage()
- addModerateMessage()
- addSuccessMessage()
|
| Message - Global |
Récupère les messages localisés à partir de la table Message [sys_ui_message]. Il prend en charge l’internationalisation (i18n) en extrayant dynamiquement les messages en fonction de la langue de la session de l’utilisateur ou d’un paramètre de langue spécifié.
- getMessage()
- getMessageLang()
|
Tableau 3. Nouvelles classes de clients et méthodes supplémentaires aux classes de clients existantes dans Zurich
| Classe |
Méthodes |
| GlideForm (g_form) - Client |
- addChoice()
- addHighMessage()
- addLowMessage()
- addModerateMessage()
- addSuccessMessage()
- clearChoices()
- disableChoice()
- enableChoice()
- getAnnotationByName()
- getAnnotations()
- getChoice()
- getOptions()
- hideAnnotation()
- hideRelatedLinks()
- hideTemplateBar()
- removeChoice()
- setChoiceLabel()
- setRelatedLinksDisplay()
- showAnnotation()
- showRelatedLinks()
- showTemplateBar()
- toggleAnnotations()
|
| GlideModal (Next Experience) - Client |
- détruire()
- get()
- getID()
- getPreference()
- getPreferences()
- renderWithContent(Objet)
- renderWithContent(Chaîne)
- setDialog()
- setPreference()
- setTitle()
- type()
|
| GlideNavigation (Next Experience) - Client |
refreshNavigator() |
| StopWatch (Next Experience) - Client |
- Chronomètre()
- getTime()
- restart()
- toString()
|
| GlideForm (Next Experience) - Client |
- addChoice()
- addHighMessage()
- addLowMessage()
- addModerateMessage()
- addSuccessMessage()
- clearChoices()
- disableChoice()
- enableChoice()
- getAnnotationByName()
- getAnnotations()
- getChoice()
- getOptions()
- hideAnnotation()
- removeChoice()
- setChoiceLabel()
- showAnnotation()
- toggleAnnotations()
|
| GlideUser (Next Experience) - Client |
getRoles() |
Tableau 4. Nouvelles API REST et points de terminaison supplémentaires aux API REST existantes dans Zurich
| API |
Points de terminaison |
| Conversation Member API |
- PUT now/conversation/member/{user_id}/drop
- PUT now/conversation/member/{user_id}/update
|
| Omnichannel Callback API |
- POST /api/sn_omni_callback/callback/attempt
- POST /api/sn_omni_callback/callback/create
- CORRECTIF /api/sn_omni_callback/callback/update
|
Tableau 5. Nouvelles API REST et points de terminaison supplémentaires aux API REST existantes dans ServiceNow Store
| Application |
Version de l'application |
API |
Points de terminaison |
| Inventaire de réseau avancé |
10.0 |
DCIM Metric Data Feed API |
POST /api/sn_ni_adv/dcim/feed/{vendorname} |
| Gestion des devis |
6.0.1 |
Quote Management API |
- SUPPRIMER /sn_tmf_api/quote_management_api/quote/{id}
- GET /sn_tmf_api/quote_management_api/devis
- OBTENIR /sn_tmf_api/quote_management_api/quote/{id}
- CORRECTIF /sn_tmf_api/quote_management_api/quote/{id}
- PUBLIER /sn_tmf_api/quote_management_api/devis
|
| API ouvertes de télécommunication |
4.1.1 |
Work Order Management API |
- ANNULER /sn_tmf_api/work_order_management_api/cancelWorkOrder
- GET /sn_tmf_api/work_order_management_api/workordermanagement
- OBTENIR /sn_tmf_api/work_order_management_api/commande de travaux/{id}
- CORRECTIF /sn_tmf_api/work_order_management_api/workOrder/{id}
- PUBLIER /sn_tmf_api/work_order_management_api/workOrder
|
Changements apportés à cette version
Tableau 6. Classes incluses dans le périmètre modifiées dans Zurich
| Classe |
Méthodes |
| GlideSysAttachment - Scoped |
Prise en charge de la copie de tout attribut à partir des enregistrements de pièce jointe source et suppression des attributs avec des pièces jointes.
- copier()
- copie(targetFieldName)
- copyAttachmentsByFieldNames()
- deleteAllAttachment()
- deleteAttachment()
|
| IdentificationEngine - Scoped |
Activez les referenceItems propriétés de la charge utile entrante à renseigner avant d’identifier un CI à l’aide des règles IRE définies sur une classe.
- createOrUpdateCI()
- createOrUpdateCIEnhanced()
- identifyCIEnhanced()
|
| ProducerV2 - Scoped |
send() - Ajout d’une valeur de retour et d’une gestion des erreurs. |
| RESTMessageV2 - Scoped, Global |
setHttpMethod() - Ajout de la prise en charge des appels de méthode HEAD via le method paramètre. |
Tableau 7. Classes globales modifiées dans Zurich
| Classe |
Méthodes |
| GlideSysAttachment - Global |
Prise en charge de la copie de tout attribut à partir des enregistrements de pièce jointe source et suppression des attributs avec des pièces jointes.
- copier()
- copie(targetFieldName)
- copyAttachmentsByFieldNames()
- deleteAllAttachment()
- deleteAttachment()
|
| IdentificationEngineScriptableApi - Global |
Activez les referenceItems propriétés de la charge utile entrante à renseigner avant d’identifier un CI à l’aide des règles IRE définies sur une classe.
- createOrUpdateCI()
- createOrUpdateCIEnhanced()
- identifyCIEnhanced()
|
| RESTMessageV2 - Scoped, Global |
setHttpMethod() - Ajout de la prise en charge des appels de méthode HEAD via le method paramètre. |
Tableau 8. API REST modifiées dans ServiceNow Store
| Application |
Version de l'application |
API |
Points de terminaison |
| Traitement de facture des comptes fournisseurs |
v9.5.17 |
AP Invoice API |
Les points de terminaison suivants prennent désormais en charge les pièces jointes :
- PUBLIER sn_spend_intg/ap_invoice/JSON
- POST sn_spend_intg/ap_invoice/xml
|
| API ouvertes de télécommunication |
v4.1.1 |
Service Order Open API |
Les points de terminaison suivants prennent désormais en charge les types de valeur de caractéristiques de service complexes via le serviceOrderItem.service.serviceCharacteristic.valueType paramètre :
- OBTENIR /sn_tmf_api/order/serviceOrder
- OBTENIR /sn_tmf_api/order/serviceOrder/{id}
- CORRECTIF /sn_tmf_api/order/serviceOrder/{id}
- PUBLIER /sn_tmf_api/order/serviceOrder
|
| API ouvertes de télécommunication |
v4.1.1 |
Product Catalog Open API |
Les points de terminaison productSpecification suivants sont mis à jour pour prendre en charge les types de valeur de caractéristiques de spécifications de produits complexes via le productSpecCharacteristic.valueType paramètre :
- POST /sn_tmf_api/catalogmanagement/productSpecification
- CORRECTIF /sn_tmf_api/catalogmanagement/productSpecification/{id}
- OBTENIR /sn_tmf_api/catalogmanagement/productSpecification/{id}
- OBTENIR /sn_tmf_api/catalogmanagement/productSpecification
|
| API ouvertes de télécommunication |
v4.1.1 |
Product Inventory Open API |
Les points de terminaison suivants prennent désormais en charge les types de valeur de caractéristiques de produit complexes via le productCharacteristic.valueType paramètre :
- OBTENIR /sn_prd_invt/produit
- OBTENIR /sn_prd_invt/product/{id}
- OBTENIR /sn_prd_invt/productinventory
- OBTENIR /sn_prd_invt/productinventory/{inventoryId}
- PUBLIER /sn_prd_invt/produit
- PUBLIER /sn_prd_invt/inventaire des produits
|
| API ouvertes de télécommunication |
v4.1.1 |
Product Order Open API |
Les points de terminaison suivants prennent désormais en charge les types de valeur de caractéristiques de produit complexes via le productOrderItem.product.productCharacteristic.valueType paramètre :
- OBTENIR /sn_ind_tmt_orm/order/productOrder
- OBTENIR /sn_ind_tmt_orm/order/productOrder/{id}
- GET /sn_ind_tmt_orm/productorder
- OBTENIR /sn_ind_tmt_orm/productorder/{id}
- CORRECTIF /sn_ind_tmt_orm/order/productOrder/{id}
- CORRECTIF /sn_ind_tmt_orm/productOrder/{id}
- PUBLIER /sn_ind_tmt_orm/commande/productOrder
- PUBLIER /sn_ind_tmt_orm/productOrder
|
| API Agent virtuel |
v4.0.0 |
Virtual Agent Bot Integration API |
Nouvelles options pour le paramètre corps de la action demande avec des exemples correspondants. POST /sn_va_as_service/bot/intégration |
Dépréciations
- L’API GlideEncrypter ne prend plus en charge la norme 3DES (Triple Data Encryption Standard) en raison de la mise à jour des directives NIST 800-131A Rév. 2 .
- Pour les instances existantes qui se mettent à niveau vers la Zurich version, l’API GlideEncrypter est disponible pour utilisation, mais a été mise à jour pour utiliser automatiquement l’algorithme Cadre de travail de gestion des clés . Consultez GlideEncrypter - Global (deprecated) pour plus d’informations sur la façon de continuer à appeler cette API.
- Pour toutes les nouvelles instances créées à partir de la Zurich version, l’API GlideEncrypter n’est plus prise en charge. Utilisez directement le à la Key Management Framework place pour toutes les opérations de cryptographie.
- Les groupes dynamiques ont été supprimés du schéma dynamique dans la plateforme principale. Pour les attributs dynamiques définis avec un groupe d’attributs dynamiques associé avant la version, deux méthodes conçues à l’origine pour les Zurich groupes d’attributs dynamiques continuent de fonctionner pour la rétrocompatibilité.
Ces méthodes renvoient null pour les attributs migrés et les attributs nouvellement créés.
Les clients sont invités à migrer vers les définitions d’attributs dynamiques actuelles pour tirer parti des améliorations futures des fonctionnalités et des fonctionnalités. Pour plus d’informations sur la migration, consultez l’article Guide de migration du schéma dynamique Zurich [KB2146133] dans la base de connaissances Now Support.
Informations sur l'activation
Les API suivantes sont disponibles par défaut :
- Identification et réconciliation
- Moteur d’identification
- IdentificationEngineScriptableApi
- Code GlideCurrencyCode
- Symbole de devise GlideCurrency
- GlideForm (Next Experience)
- GlideModal (Next Experience)
- GlideNavigation (Next Experience)
- GlideRecord
- GlideSysAttachment
- GlideUser (Next Experience)
- Chronomètre (Next Experience)
Les API suivantes nécessitent l’activation du module d’extension :
- ProducerV2 nécessite le module d’extension ServiceNow Stream Connect Installer (com.glide.hub.stream_connect.installer).
- Commande de produit ouverte L’API nécessite le module d’extension Order Management for Telecommunications (sn_ind_tmt_orm).
- Commande de service ouverte L’API nécessite le module d’extension Order Management for Telecommunications (sn_ind_tmt_orm).