Notes de version de l’API

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 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 Xanadu version.

    Points forts de l’API pour la Xanadu version

    • Utilisez des API JavaScript côté serveur dans les scripts pour modifier la fonctionnalité 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.

    Nouveautés de la version Xanadu

    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 Xanadu
    Classe Méthodes
    CMDBQBScopedScriptableAPI - Scoped
    • createReport()
    • deleteQuery()
    • getSavedQueryExecutionDetails()
    • saveQuery()
    • updateQuery()
    HistoryWalker - Scoped, Global walkTo(point de contrôle)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDAutomationProvider - Scoped, Global
    • activateProcess()
    • deactivateProcess()
    • duplicateProcess()
    PDFGenerationAPI - Scoped, Global redact()
    PersonalAuthAPI - Scoped
    • PersonalAuthAPI()
    • getInitiatorURL()
    • isTokenValid()
    • revokeToken()
    PlaybookExperience - Scoped restartPlaybook()
    Tableau 2. De nouvelles classes globales et des méthodes supplémentaires aux classes globales existantes dans Xanadu
    Classe Méthodes
    CMDBQueryBuilderAPI - Global
    • createReport()
    • deleteQuery()
    • saveQuery()
    • updateQuery()
    DynamicSchemaAPI - Global
    • clearDynamicCategoryCache()
    • clearDynamicChoiceSetCache()
    • clearDynamicAttributeGroupCache()
    • clearDynamicAttributeGroupCacheItem()
    • clearDynamicCategoryCacheItem()
    • clearDynamicChoiceSetItem()
    • obtenir()
    GlideAggregate - Global
    • getDynamicAttributeValue() : deux signatures
    • getDynamicAttributeDisplayValue() : deux signatures
    GlideDate - Global parseDate()
    GlideDynamicAttributeStore - Global
    • clear()
    • getDisplayValue()
    • getValue()
    • setDisplayValue()
    • setDynamicAttributeDisplayValue()
    • setDynamicAttributeValue()
    • setDynamicAttributeValues()
    • setValue()
    • toString()
    GlideElementDynamicAttributeStore - Global
    • getDynamicAttribute()
    • getDynamicAttributeDisplayValue()
    • getDynamicAttributeValue()
    • setDynamicAttributeValue()
    • setDynamicAttributeValues()
    • setDynamicAttributeDisplayValue()
    • setDynamicAttributeDisplayValues()
    GlideRecord - Global
    • getDynamicAttribute() - deux signatures
    • getDynamicAttributeValue() : deux signatures
    • getDynamicAttributeDisplayValue() : deux signatures
    • setDynamicAttributeValue() - deux signatures
    • setDynamicAttributeDisplayValue() : deux signatures
    • setDynamicAttributeValues()
    HistoryWalker - Scoped, Global walkTo(point de contrôle)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDFGenerationAPI - Scoped, Global redact()
    Tableau 3. Nouvelles API mobiles clientes et méthodes supplémentaires aux API mobiles clientes existantes dans Xanadu
    Classe Méthodes
    m_form - Client
    • addErrorMessage()
    • addInfoMessage()
    • getValue()
    • setAffectedInputs()
    • setValue()
    MobileScriptIncludeCaller - Client
    • MobileScriptIncludeCaller()
    • addParam()
    • call()
    Tableau 4. Nouvelles API REST dans Xanadu
    Classe Méthodes
    Cloud Services Catalog API
    • OBTENIR /maintenant/cmp_catalog_api/itemsbyciclass
    • OBTENIR /maintenant/cmp_catalog_api/itemsbyrb
    • OBTENIR /maintenant/cmp_catalog_api/services
    • OBTENIR /maintenant/cmp_catalog_api/piles
    • OBTENIR /maintenant/cmp_catalog_api/état
    • PUBLIER /maintenant/cmp_catalog_api/submitoprequest
    • PUBLIER /maintenant/cmp_catalog_api/submitrequest
    Proactive Engagement API CRÉER /api/sn_pren/self_remediation/experience_issue/create
    Tableau 5. Nouvelles classes client et méthodes supplémentaires aux classes clients existantes dans le ServiceNow magasin
    Classe Méthodes
    openFrameAPI - Client getAWAAgentPresence()
    Tableau 6. Nouvelles classes dans le champ d’application et méthodes supplémentaires aux classes dans le champ d’application existantes dans le ServiceNow magasin
    Classe Méthodes
    sb - Scoped, Global
    • archive()
    • checkout()
    • publish()
    • retire()
    Tableau 7. Nouvelles classes globales et méthodes supplémentaires aux classes globales existantes dans la ServiceNow boutique
    Classe Méthodes
    sb - Scoped, Global
    • archive()
    • checkout()
    • publish()
    • retire()
    Tableau 8. Nouvelles API REST dans la ServiceNow boutique
    Classe Méthodes
    Proactive Engagement API CRÉER /sn_pren/self_remediation/experience_issue/créer
    Product Catalog Open API
    • SUPPRIMER /sn_tmf_api/catalogmanagement/productOffering/{id}
    • SUPPRIMER /sn_tmf_api/catalogmanagement/productSpecification/{id}
    • CORRECTIF /sn_tmf_api/catalogmanagement/productOffering/{id}
    • CORRECTIF /sn_tmf_api/catalogmanagement/productSpecification/{id}
    Resource Inventory Open API Ajout de la prise en charge des tables Câble, Fil et Topologie. Ce changement est reflété dans les descriptions des propriétés @type, ID et resourceRelationship.resource.
    • SUPPRIMER /sn_ni_core/ressource/{id}
    • OBTENIR /sn_ni_core/ressource
    • OBTENIR /sn_ni_core/ressource/{id}
    • CORRECTIF /sn_ni_core/ressource/{id}
    • PUBLIER /sn_ni_core/ressource
    • PUBLIER /sn_ni_core/resourceinventoryviatemplate
    Service Test Management Open API
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
    • OBTENIR /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
    • CORRECTIF /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
    • CORRECTIF /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
    • POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
    • POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
    TISC API PUBLIER /sn_sec_tisc/threat_intel_data/add_observables

    Changements apportés à cette version

    Tableau 9. Classes incluses dans le périmètre modifiées dans Xanadu
    Classe Méthodes
    HistoryWalker - Scoped, Global Ajout d’un paramètre permettant de spécifier le type d’implémentation du marcheur d’historique à utiliser.

    HistoryWalker()
    Tableau 10. Classes globales modifiées dans Xanadu
    Classe Méthodes
    GlideAggregate - Global Ajout de la prise en charge du schéma dynamique.
    • addAggregate()
    • addHaving()
    • getValue()
    • groupBy()
    • orderBy()
    • orderByAggregate()
    GlideRecord - Global Ajout de la prise en charge du schéma dynamique.
    • addQuery()
    • getDisplayValue()
    • getValue()
    • orderBy()
    • orderByDesc()
    • setDisplayValue()
    • setValue()
    HistoryWalker - Scoped, Global Ajout d’un paramètre permettant de spécifier le type d’implémentation du marcheur d’historique à utiliser.

    HistoryWalker()
    Tableau 11. API REST modifiées dans Xanadu
    Classe Méthodes
    AWA Manual Assignment API Ajout de nouveaux paramètres de corps de demande.

    PUBLIER /awa/workitems/{work_item_sys_id}/affectations
    Continuous Integration/Continuous Delivery (CICD) API Ajout de nouveaux paramètres de requête facultatifs pour spécifier s’il faut exécuter une suite de tests en tant que test de performances et dans Cloud Runner.

    POST /sn_cicd/testsuite/run
    Tableau 12. Classes incluses dans le périmètre modifiées dans le ServiceNow magasin
    Classe Méthodes
    LeadtoCashCore - Scoped L’include de script LeadtoCashCore est amélioré pour prendre en charge les cas d’utilisation de reconfiguration :
    • createInstance() : renvoie _state l’identification de la valeur actif ou inactif de l’enregistrement d’entité.
    • delta() - additionalParams prend désormais en charge la possibilité d’ignorer les attributs à comparer dans les JSON source et dirtyJSON.
    • effect() - additionalParams prend maintenant en charge la possibilité de fournir des clés de variables de contexte au lieu de noms de champs de dictionnaire. De plus, effect() renvoie le _state paramètre identifiant si l’enregistrement d’entité est dans un état actif ou inactif.
    Tableau 13. API clientes modifiées dans la ServiceNow boutique
    Classe Méthodes
    openFrameAPI - Client Charges utiles ajoutées workitem_rejected et workitem_accepted de réponse.

    subscribe()
    Tableau 14. API REST modifiées dans la ServiceNow boutique
    Classe Méthodes
    Service Order Open API
    • Pour tous les points de terminaison, l’espace de noms et les chemins d’accès des points de terminaison sont passés de sn_ind_tmt_ord à sn_tmf_api.
    • Les méthodes suivantes renvoient deux nouveaux paramètres, href et orderDate.
      • GET /sn_tmf_api/order/serviceOrder
      • POST /sn_tmf_api/order/serviceOrder/cancelserviceorder
      • API ouverte de commande de service : POST /sn_tmf_api/order/serviceOrder
      • PUBLIER /sn_tmf_api/order/serviceOrder/outboundresponse
    Product Catalog Open API
    • Pour tous les points de terminaison, l’espace de noms et les chemins d’accès des points de terminaison sont passés de sn_ind_tmt_ord à sn_tmf_api.
    • productOffering renvoient deux nouveaux paramètres facultatifs, href et lifecycleStatus:
      • OBTENIR /sn_tmf_api/catalogmanagement/productOffering
      • OBTENIR /sn_tmf_api/catalogmanagement/productOffering/{id}
      • CORRECTIF /sn_tmf_api/catalogmanagement/productOffering/{id}
      • PUBLIER /sn_tmf_api/catalogmanagement/productOffering
    • productSpecification renvoient trois nouveaux paramètres facultatifs, isBundle, hrefet lifecycleStatus:
      • GET /sn_tmf_api/catalogmanagement/productSpecification
      • GET /sn_tmf_api/catalogmanagement/productSpecification/{id}
      • CORRECTIF /sn_tmf_api/catalogmanagement/productSpecification/{id}
      • POST /sn_tmf_api/catalogmanagement/productSpecification
    WSD Extra Service Request API Ajout d’un nouveau paramètre de corps de la demande, reservationDateTimeChanged.

    OBTENIR /sn_wsd_rsv/réservable/list_reservables/{sys_ids}
    WSD Reservable API Ajout d’un nouveau paramètre de requête, reservation_start_time.

    OBTENIR /sn_wsd_rsv/réservable/list_reservables/{sys_ids}
    WSD Reservable V2 API Ajout d’un nouveau paramètre de requête, reservation_start_time.

    PUBLIER /sn_wsd_rsv/v2/réservable/list_reservables

    Informations sur l'activation

    Les API suivantes sont disponibles par défaut :
    • Cloud Services Catalog API
    • DynamicSchemaAPI
    • Agrégat Glide
    • Date Glide
    • GlideDynamicAttributeStore
    • GlideElementAttributeStore
    • GlideRecord
    • HistoryWalker (en anglais seulement)
    • Formateur de numéro
    • openFrameAPI
    • PDAutomationProvider (en anglais seulement)
    • PDFGenerationAPI
    • PlaybookExperience
    • Catalogue de produits : API ouverte
    • Commande de service : API ouverte
    Les API suivantes nécessitent l’activation du module d’extension :
    • L’API d’affectation manuelle AWA nécessite l’activation du module d’extension Affectation de travail avancée (com.glide.awa).
    • PersonalAuthAPI nécessite l’activation du module d’extension Personal Authentication (com.snc.sn_ihub_personal_auth).
    • L’API Engagement proactif nécessite l’activation du module d’extension Engagement proactif (proactive-engagement).
    • L’application PSBPublicAPIUtil nécessite l’activation des Pont de services modules d’extension pour les fournisseurs (sn_sb_pro) et Base Pont de services (sn_sb).
    • L’API ouverte d’inventaire des ressources nécessite l’activation du module d’extension Application principale d’inventaire du réseau client (com.app-ni-core).
    • L’API ouverte de gestion des tests de service nécessite l’activation du module d’extension Gestion des problèmes du service clientèle (com.sn_sprb_mgmt).
    • L’API de demande de service supplémentaire WSD nécessite l’activation du module d’extension Workplace Reservation Management (com.sn_wsd_rsv).
    • L’API réservable WSD nécessite l’activation du module d’extension Workplace Reservation Management (com.sn_wsd_rsv).
    • L’API WSD Reservable V2 nécessite l’activation du module d’extension Workplace Reservation Management (com.sn_wsd_rsv).