Notes de version de l’API

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 5 minutes de lecture

    • 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 Yokohama version.

    Points forts de l’API pour la Yokohama 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.

    Consultez API implementation and reference pour plus d'informations.

    Nouveau dans la Yokohama version

    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 Yokohama
    Classe Méthodes
    Console - Scoped, Global
    • erreur()
    • groupe()
    • groupCollapsedString()
    • groupEnd()
    • info()
    • journal ()
    • table()
    • temps()
    • timeEnd()
    • timeLog()
    • trace()
    • warn()
    Fetch - Scoped, Global fetch()
    Fetch Headers - Scoped, Global
    • En-têtes ()
    • append()
    • supprimer()
    • entrées()
    • forEach()
    • get()
    • getSetCookie()
    • has()
    • clés()
    • set()
    • valeurs()
    Fetch Request - Scoped, Global
    • Demande()
    • tableauTampon()
    • blob()
    • octets()
    • clone()
    • formData()
    • json()
    • texte()
    Fetch RequestInit - Scoped, Global requestInit()
    Fetch Response - Scoped,Global
    • tableauTampon()
    • blob()
    • octets()
    • formData()
    • json()
    • texte()
    GlideUser - Scoped
    • getTimeZoneLabel()
    • getTimeZoneLabelLang()
    OrderUtil - Scoped
    • getStateFromOrder()
    • isOrderInDraftState()
    PDFGenerationAPI - Scoped, Global
    • convertToPDFAsync()
    • convertToPDFWithHeaderFooterAsync()
    ProcessMiningIntegrationAPI - Scoped
    • createProject()
    • deleteProject()
    • getBreakDownStats()
    • getFindings()
    • getMiningStatus()
    • getProject()
    • scheduleMining()
    RESTMessageV2 - Scoped, Global setAllowedRedirectURIs()
    SOAPMessageV2 - Scoped, Global
    • setAllowedRedirectURIs()
    • setFollowRedirect()
    UriMatcher - Scoped
    • UriMatcher()
    • match()
    UriMatcherResponse - Scoped
    • getErrorMessages()
    • isError()
    • isFragmentMatches()
    • isHostMatches()
    • isMatch()
    • isPathMatches()
    • isSchemeMatches()
    v_record - Scoped, Global setLastErrorMessage()
    Tableau 2. Nouvelles classes globales et méthodes supplémentaires aux classes globales existantes dans Yokohama
    Classe Méthodes
    Console - Scoped, Global
    • erreur()
    • groupe()
    • groupCollapsedString()
    • groupEnd()
    • info()
    • journal ()
    • table()
    • temps()
    • timeEnd()
    • timeLog()
    • trace()
    • warn()
    Fetch - Scoped, Global fetch()
    Fetch Headers - Scoped, Global
    • En-têtes ()
    • append()
    • supprimer()
    • entrées()
    • forEach()
    • get()
    • getSetCookie()
    • has()
    • clés()
    • set()
    • valeurs()
    Fetch Request - Scoped, Global
    • Demande()
    • tableauTampon()
    • blob()
    • octets()
    • clone()
    • formData()
    • json()
    • texte()
    Fetch RequestInit - Scoped, Global requestInit()
    Fetch Response - Scoped,Global
    • tableauTampon()
    • blob()
    • octets()
    • formData()
    • json()
    • texte()
    GlideDynamicAttribute - Global
    • getSysId()
    • getName()
    • getType()
    • getGroupName()
    • getPath()
    • isTransient()
    GlideDynamicAttributeStore - Global getDynamicAttributes()
    GlideElementDynamicAttributeStore - Global
    • getDynamicAttributesInSchema()
    • getDynamicAttributesInStore()
    GlideTransientDynamicAttribute - Global
    • getSysId()
    • getName()
    • getType()
    • getGroupName()
    • getPath()
    • isTransient()
    GlideUser - Global
    • getTimeZoneLabel()
    • getTimeZoneLabelLang()
    PDFGenerationAPI - Scoped, Global
    • convertToPDFAsync()
    • convertToPDFWithHeaderFooterAsync()
    • getCurrencyCode()
    • getNumericCurrencyCode()
    RESTMessageV2 - Scoped, Global setAllowedRedirectURIs()
    SOAPMessageV2 - Scoped, Global
    • setAllowedRedirectURIs()
    • setFollowRedirect()
    Tableau 3. Nouvelles API REST et points de terminaison supplémentaires aux API REST existantes dans Yokohama
    API Points de terminaison
    AWA Offer Work API PUBLIER /now/awa/documents/{document_table}/{document_sys_id}/offer
    Continuous Integration and Continuous Delivery (CICD) Update Set API
    • PUBLIER /sn_cicd/update_set/récupérer
    • PUBLIER /sn_cicd/update_set/commitMultiple
    • PUBLIER /sn_cicd/update_set/aperçu/{remote_update_set_id}
    • PUBLIER /sn_cicd/update_set/back_out
    • PUBLIER /sn_cicd/update_set/valider/{remote_update_set_id}
    • PUBLIER /sn_cicd/update_set/créer
    Tableau 4. Nouvelles classes du champ d’application et méthodes supplémentaires aux classes du champ d’application existantes dans le ServiceNow Store
    Demande Version de l'application Classe Méthodes
    Gestion des pistes v3.0 LeadAPIHelperOOB - Scoped
    • getJSONFromGR()
    • getLeadsJSON()
    • getTransformedLead()
    Gestion des pistes v3.0 LeadAPIProcessUtilOOB - Scoped
    • processCreateLead()
    • processGetAllLeads()
    • processGrtLeadById()
    • processUpdateLead()
    Gestion des pistes v3.0 LeadAPIValidationUtilOOB - Scoped
    • validateLeadObjectForPatchCall()
    • validateLeadObjectForPostCall()
    Gestion des commandes v6.0 OrderGuide - Scoped isOrderInDraftState()
    Tableau 5. Nouvelles classes de clients et méthodes supplémentaires aux classes de clients existantes dans la ServiceNow Store
    Demande Version de l'application Classe Méthodes
    Gestion du service clientèle v1.2 openFrameAPI - Client setICContext()
    Tableau 6. Nouvelles API REST et points de terminaison supplémentaires aux API REST existantes dans ServiceNow Store
    Demande Version de l'application API Points de terminaison
    Opérations de comptes fournisseurs v8.0 AP Invoice API
    • POST /sn_spend_intg/ap_invoice/xml
    Modèle de produit et classes d’actifs développés v1.0 AI Assets API
    • OBTENIR /sn_ent/asset/ai_dataset/{sys_id}
    • OBTENIR /sn_ent/asset/ai_model/{sys_id}
    • OBTENIR /sn_ent/asset/ai_prompt/{sys_id}
    • OBTENIR /sn_ent/asset/ai_system/{sys_id}
    • PUBLIER /sn_ent/asset/ai_dataset
    • PUBLIER sn_ent/asset/ai_model
    • PUBLIER /sn_ent/asset/ai_prompt
    • PUBLIER /sn_ent/asset/ai_system
    • PUT /sn_ent/asset/ai_dataset/{sys_id}
    • PUT /sn_ent/asset/ai_model/{sys_id}
    • PUT /sn_ent/asset/ai_prompt/{sys_id}
    • PUT /sn_ent/asset/ai_system/{sys_id}
    Contrats clients et droits v6.0 Service Contract API
    • POST /sn_pss_core/servicecontract
    • OBTENIR /sn_pss_core/servicecontract/{id}
    • POST /sn_pss_core/servicecontract/contractline
    • OBTENIR /sn_pss_core/servicecontract/contractline/{id}
    Contrats clients et droits v6.0 Verify Entitlements API GET /sn_ent_verify/verifyentitlements
    Gestion des pistes v3.0 lead API
    • OBTENIR /sn_lead_mgmt_core/piste
    • OBTENIR /sn_lead_mgmt_core/lead/{sys_id}
    • CORRECTIF /sn_lead_mgmt_core/lead/{sys_id}
    • PUBLIER /sn_lead_mgmt_core/lead
    Gestion des ventes et des commandes v4.0 Sales Agreement API
    • OBTENIR /sn_sales_agmt_core/contrat de vente /{id}
    • PUBLIER /sn_sales_agmt_core/contrat de vente

    Changements apportés à cette version

    Tableau 7. Classes incluses dans le périmètre modifiées dans Yokohama
    Classe Méthodes
    PDFGenerationAPI - Scoped, Global
    • convertToPDF()
    • convertToPDFWithHeaderFooter()

    De nouvelles propriétés, glide.pdf.url.whitelisting.enabled et com.snc.pdf.whitelisted_urls, ont été ajoutées pour garantir que les URL externes fournies doivent être restituées dans la sortie PDF.

    Une nouvelle propriété, accessibilityEnabled, a été ajoutée pour la prise en charge de l’accessibilité PDF.
    Tableau 8. Classes globales modifiées dans Yokohama
    Classe Méthodes
    PDFGenerationAPI - Scoped, Global
    • convertToPDF()
    • convertToPDFWithHeaderFooter()

    De nouvelles propriétés, glide.pdf.url.whitelisting.enabled et com.snc.pdf.whitelisted_urls, ont été ajoutées pour garantir que les URL externes fournies doivent être restituées dans la sortie PDF.

    Une nouvelle propriété, accessibilityEnabled, a été ajoutée pour la prise en charge de l’accessibilité PDF.
    Tableau 9. API REST modifiées dans Yokohama
    API Points de terminaison
    Attachment API POST /now/attachment/file : Un nouveau paramètre, creation_time, peut être utilisé pour capturer les heures de création de pièce jointe lorsque le Application Now Mobile est hors ligne et que la pièce jointe est téléchargée dans un enregistrement ultérieurement.
    Tableau 10. Classes incluses dans le périmètre modifiées dans le ServiceNow Store
    Demande Version de l'application Classe Méthodes
    Prospect vers trésorerie core V1.4 LeadtoCashCore - Scoped Performances améliorées de l’API d’instance de validation afin d’améliorer la génération de numéros pour le champ de numéro :
    • effect() : L’objet _records_count return est ajouté pour fournir des détails sur les enregistrements nouvellement insérés pour une table particulière, tels que le nom de la table et le nombre d’enregistrements insérés.
    • commitInstance() : un nouveau paramètre supplémentaire, useNumberGenerator, est ajouté pour générer et appliquer éventuellement des sys_ids à de nouveaux enregistrements de table en bloc.
    Tableau 11. Classes client modifiées dans ServiceNow Store
    Demande Version de l'application Classe Méthodes
    Gestion du service clientèle v1.2 openFrameAPI - Client subscribe() : Ajout de nouveaux événements
    • openframe_wrap_up_submitted
    • openframe_heart_beat
    Tableau 12. API REST modifiées dans ServiceNow Store
    Demande Version de l'application API Points de terminaison
    Opérations de comptes fournisseurs v8.0 AP Invoice API Ajoutez des propriétés prenant en charge les informations sur l’adresse de facturation.
    • POST /sn_spend_intg/ap_invoice/cxml
    • PUBLIER /sn_spend_intg/ap_invoice/json

    Informations sur l'activation

    Les API suivantes sont disponibles par défaut :
    • Pièce jointe
    • Console
    • Extraire
    • Fetch.Headers
    • Extraire.Demande
    • Récupérer.Réponse
    • Fetch.RequestInit
    • Attribut GlideDynamicAttribute
    • Magasin GlideDynamicAttributeStore
    • Magasin GlideElementDynamicAttributeStore
    • GlideTransientDynamicAttribute
    • GlideUser
    • openFrameAPI
    • PDFGenerationAPI
    • RESTMessageV2
    • ScriptableCurrencyCode
    • ScriptableUriMatcher
    • SOAPMessageV2
    • UriMatcher
    • Réponse UriMatcherResponse
    Les API suivantes nécessitent l’activation du module d’extension :
    • L’API des actifs IA nécessite l’activation du module d’extension Classes d’actifs (sn_ent).
    • L’API de facture AP nécessite l’activation du module d’extension Traitement des factures des comptes fournisseurs (com.sn_ap_apm).
    • L’API Offre de travail AWA nécessite l’activation du module d’extension Affectation de travail avancée (com.glide.awa).
    • L’API de piste nécessite l’activation du module d’extension Lead Management Data Model (sn_lead_mgmt_core).
    • L’API OpenFrame nécessite l’activation du module d’extension com.sn_openframe_store.
    • L’API OrderUtil (script include) nécessite l’activation du module d’extension Order Management (com.sn_ind_tmt_orm).
    • Le module d’extension Exploration de processus principal (com.sn_process_optimization) nécessite l’activation de ProcessMiningIntegrationAPI .
    • L’API du contrat de vente nécessite l’activation des modules d’extension suivants :
      • Modèle de données du contrat de vente (com.sn_sales_agmt_core)
      • Gestion du catalogue de produits Core (com.sn_prd_pm)
      • Prix (com.sn_csm_pricing)
    • L’API de contrat de service nécessite l’activation des modules d’extension suivants :
      • Contrats clients et droits (com.sn_pss_core)
      • Gestion de la base d’installation du Service clientèle (com.snc.install)
      • Gestion du catalogue de produits Core (com.sn_prd)
    • L’API v_record nécessite l’activation du module d’extension Tables distantes (com.glide.script.vtable).
    • L’API Vérifier les autorisations nécessite l’activation du module d’extension Vérification de l’autorisation (com.sn_ent_verify).