API-Versionshinweise

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 5 Minuten Lesedauer

    • ServiceNow® Mit APIs können Sie anwenderdefinierte Anwendungen und Experiences erstellen. APIs wurden im Release Xanadu verbessert und aktualisiert.

    API-Highlights für das Release Xanadu .

    • Verwenden Sie serverseitige JavaScript-APIs in Skripts, um die Anwendungsfunktionalität zu ändern.
    • Führen Sie Client-APIs aus, wenn ein clientbasiertes Ereignis auftritt, z. B. wenn ein Formular geladen oder übermittelt wird oder wenn sich ein Feldwert ändert.
    • Verwenden Sie eingehende REST APIs für die Interaktion mit verschiedenen ServiceNow -Funktionalitäten in Ihrer Anwendung.

    Weitere Informationen finden Sie unter API implementation and reference.

    Neu im Xanadu-Release

    Tabelle : 1. Neue bereichsbezogene Klassen und zusätzliche Methoden für vorhandene bereichsbezogene Klassen in Xanadu
    Klasse Methoden
    CMDBQBScopedScriptableAPI - Scoped
    • erstellenBericht ()
    • löschenAbfrage()
    • abrufenGespeicherteAbfrageAusführungsDetails()
    • speichernAbfrage()
    • updateQuery ()
    HistoryWalker - Scoped, Global walkTo (Prüfpunkt)
    NumberFormatter - Scoped, Global
    • parseWithLocale ()
    • parseWithSeparators()
    PDAutomationProvider - Scoped, Global
    • aktivierenProzess()
    • deaktivierenProzess ()
    • duplicateProzess ()
    PDFGenerationAPI - Scoped, Global schwärzen ()
    PersonalAuthAPI - Scoped
    • PersonalAuthAPI ()
    • abrufenInitiatorURL()
    • isTokenValid ()
    • widerrufenToken ()
    PlaybookExperience - Scoped NeustartPlaybook ()
    Tabelle : 2. Neue globale Klassen und zusätzliche Methoden für vorhandene globale Klassen in Xanadu
    Klasse Methoden
    CMDBQueryBuilderAPI - Global
    • erstellenBericht ()
    • löschenAbfrage()
    • speichernAbfrage()
    • updateQuery ()
    DynamicSchemaAPI - Global
    • ClearDynamicCategoryCache ()
    • ClearDynamicChoiceSetCache ()
    • ClearDynamicAttributeGroupCache ()
    • klaresDynamischesAttributGruppeCacheElement ()
    • klaresDynamischesKategorieCacheElement ()
    • klaresDynamischesAuswahlsetElement ()
    • abrufen ()
    GlideAggregate - Global
    • getDynamicAttributeValue(): zwei Signaturen
    • getDynamicAttributeDisplayValue(): zwei Signaturen
    GlideDate - Global Datumsanalyse ()
    GlideDynamicAttributeStore - Global
    • löschen ()
    • abrufenAnzeigewert()
    • abrufenWert()
    • festlegenAnzeigewert()
    • festlegenDynamischesAttributAnzeigewert()
    • festlegenDynamischerAttributwert()
    • festlegenDynamischeAttributwerte()
    • setValue()
    • toString()
    GlideElementDynamicAttributeStore - Global
    • abrufenDynamischesAttribut ()
    • abrufenDynamischesAttributAnzeigewert()
    • abrufenDynamischerAttributwert()
    • festlegenDynamischerAttributwert()
    • festlegenDynamischeAttributwerte()
    • festlegenDynamischesAttributAnzeigewert()
    • festlegenDynamischeAttributAnzeigewerte()
    GlideRecord - Global
    • getDynamicAttribute(): zwei Signaturen
    • getDynamicAttributeValue(): zwei Signaturen
    • getDynamicAttributeDisplayValue(): zwei Signaturen
    • setDynamicAttributeValue(): zwei Signaturen
    • setDynamicAttributeDisplayValue(): zwei Signaturen
    • festlegenDynamischeAttributwerte()
    HistoryWalker - Scoped, Global walkTo (Prüfpunkt)
    NumberFormatter - Scoped, Global
    • parseWithLocale ()
    • parseWithSeparators()
    PDFGenerationAPI - Scoped, Global schwärzen ()
    Tabelle : 3. Neue mobile Client-APIs und zusätzliche Methoden für vorhandene mobile Client-APIs in Xanadu
    Klasse Methoden
    m_form - Client
    • hinzufügenFehlermeldung ()
    • hinzufügenInfoNachricht ()
    • abrufenWert()
    • festlegenBetroffeneEingaben()
    • setValue()
    MobileScriptIncludeCaller - Client
    • MobileScriptIncludeCaller()
    • hinzufügenParam ()
    • Anruf ()
    Tabelle : 4. Neue REST APIs in Xanadu
    Klasse Methoden
    Cloud Services Catalog API
    • GET /now/cmp_catalog_api/itemsbyciclass
    • GET /now/cmp_catalog_api/itemsbyrb
    • /now/cmp_catalog_api/services abrufen
    • /now/cmp_catalog_api/stacks ABRUFEN
    • GET /now/cmp_catalog_api/status
    • POST /now/cmp_catalog_api/submitoprequest
    • POST /now/cmp_catalog_api/submitrequest
    Proactive Engagement API CREATE /api/sn_pren/self_remediation/experience_issue/create
    Tabelle : 5. Neue Client-Klassen und zusätzliche Methoden für vorhandene Client-Klassen im Store ServiceNow
    Klasse Methoden
    openFrameAPI - Client abrufenAWAAgentPresence()
    Tabelle : 6. Neue bereichsbezogene Klassen und zusätzliche Methoden für vorhandene bereichsbezogene Klassen im Store ServiceNow
    Klasse Methoden
    sb - Scoped, Global
    • Archiv ()
    • Auschecken ()
    • veröffentlichen ()
    • stilllegen ()
    Tabelle : 7. Neue globale Klassen und zusätzliche Methoden für vorhandene globale Klassen im Store ServiceNow
    Klasse Methoden
    sb - Scoped, Global
    • Archiv ()
    • Auschecken ()
    • veröffentlichen ()
    • stilllegen ()
    Tabelle : 8. Neue REST APIs im Store ServiceNow .
    Klasse Methoden
    Proactive Engagement API CREATE /sn_pren/self_remediation/experience_issue/create
    Product Catalog Open API
    • /sn_tmf_api/catalogmanagement/productOffering/{id} LÖSCHEN
    • /sn_tmf_api/catalogmanagement/productSpecification/{id} LÖSCHEN
    • PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}
    • PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
    Resource Inventory Open API Unterstützung für Kabel-, Litzen- und Topologietabellen hinzugefügt. Diese Änderung spiegelt sich in den Beschreibungen der Eigenschaften @type, id und resourceRelationship.resource wider.
    • /sn_ni_core/resource/{id} LÖSCHEN
    • GET /sn_ni_core/resource
    • GET /sn_ni_core/resource/{id}
    • PATCH /sn_ni_core/resource/{id}
    • POST /sn_ni_core/resource
    • POST /sn_ni_core/resourcenventoryviatemplate
    Service Test Management Open API
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
    • GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
    • PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
    • PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
    • POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
    • POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
    TISC API POST /sn_sec_tisc/threat_intel_data/add_observables

    Änderungen in diesem Release

    Tabelle : 9. Bereichsbezogene Klassen in geändert Xanadu
    Klasse Methoden
    HistoryWalker - Scoped, Global Parameter zum Angeben des Typs der zu verwendenden Verlaufs-Walker-Implementierung hinzugefügt.

    VerlaufsWalker ()
    Tabelle : 10. Globale Klassen in geändert Xanadu
    Klasse Methoden
    GlideAggregate - Global Unterstützung für dynamisches Schema hinzugefügt.
    • hinzufügenAggregat ()
    • hinzufügenHaben ()
    • abrufenWert()
    • groupBy ()
    • sortierenNach ()
    • sortierenNachAggregat ()
    GlideRecord - Global Unterstützung für dynamisches Schema hinzugefügt.
    • addQuery()
    • abrufenAnzeigewert()
    • abrufenWert()
    • sortierenNach ()
    • sortierenNachDesc()
    • festlegenAnzeigewert()
    • setValue()
    HistoryWalker - Scoped, Global Parameter zum Angeben des Typs der zu verwendenden Verlaufs-Walker-Implementierung hinzugefügt.

    VerlaufsWalker ()
    Tabelle : 11. geänderte REST APIs in Xanadu
    Klasse Methoden
    AWA Manual Assignment API Neue Parameter für Anforderungstext hinzugefügt.

    POST /awa/workitems/{work_item_sys_id}/assignments
    Continuous Integration/Continuous Delivery (CICD) API Neue optionale Abfrageparameter zum Festlegen, ob eine Test-Suite als Leistungstest und in Cloud Runner ausgeführt werden soll, wurden hinzugefügt.

    POST /sn_cicd/testsuite/run
    Tabelle : 12. Bereichsbezogene Klassen im Store ServiceNow geändert
    Klasse Methoden
    LeadtoCashCore - Scoped Die LeadtoCashCore-Skripteinbindung wurde erweitert, um Anwendungsfälle für die Neukonfiguration zu unterstützen:
    • createInstance(): Gibt _state zurück und gibt an, ob sich der Entitätsdatensatz im Status „Aktiv“ oder „Inaktiv“ befindet.
    • Delta() – additionalParams unterstützt jetzt die Möglichkeit, Attribute für den Vergleich in Quell- und Redaktions-JSONs zu ignorieren.
    • Wirkung () – additionalParams unterstützt jetzt die Möglichkeit, Kontextvariablenschlüssel anstelle von Wörterbuchfeldnamen anzugeben. Darüber hinaus gibt Wirkung () den Parameter _state zurück, der angibt, ob sich der Entitätsdatensatz im Status „Aktiv“ oder „Inaktiv“ befindet.
    Tabelle : 13. Geänderte Client-APIs im Store ServiceNow
    Klasse Methoden
    openFrameAPI - Client workitem_rejected und workitem_accepted Antwortnutzlasten hinzugefügt.

    Abonnieren ()
    Tabelle : 14. Geänderte REST APIs im Speicher ServiceNow
    Klasse Methoden
    Service Order Open API
    • Für alle Endpunkte wurden der Namespace und die Endpunktpfade von „sn_ind_tmt_ord“ in „sn_tmf_api“ geändert.
    • Die folgenden Methoden geben die beiden neuen Parameter href und orderDatezurück.
      • GET /sn_tmf_api/order/serviceOrder
      • POST /sn_tmf_api/order/serviceOrder/cancelserviceorder
      • Serviceauftrags-Offene API – POST /sn_tmf_api/order/serviceOrder
      • POST /sn_tmf_api/order/serviceOrder/outboundresponse
    Product Catalog Open API
    • Für alle Endpunkte wurden der Namespace und die Endpunktpfade von „sn_ind_tmt_ord“ in „sn_tmf_api“ geändert.
    • Die ProductOffering-Methoden geben die beiden neuen optionalen Parameter href und lifecycleStatuszurück:
      • GET /sn_tmf_api/catalogmanagement/productOffering
      • GET /sn_tmf_api/catalogmanagement/productOffering/{id}
      • PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}
      • POST /sn_tmf_api/catalogmanagement/productOffering
    • Die Methoden für die Produktspezifikation geben die drei neuen optionalen Parameter isBundle, hrefund lifecycleStatuszurück:
      • GET /sn_tmf_api/catalogmanagement/productSpecification
      • GET /sn_tmf_api/catalogmanagement/productSpecification/{id}
      • PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
      • POST /sn_tmf_api/catalogmanagement/productSpecification
    WSD Extra Service Request API Neuer Anforderungstextparameter „reservierungDateTimeChanged“ wurde hinzugefügt.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    WSD Reservable API Neuer Abfrageparameter „reservierung_start_time“ wurde hinzugefügt.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    WSD Reservable V2 API Neuer Abfrageparameter „reservierung_start_time“ wurde hinzugefügt.

    POST /sn_wsd_rsv/v2/reservable/list_reservables

    Aktivierungsinformationen

    Die folgenden APIs sind standardmäßig verfügbar:
    • Cloud Services Catalog-API
    • DynamicSchemaAPI
    • GlideAggregate
    • GlideDate
    • GlideDynamicAttributeStore
    • GlideElementAttributeStore
    • GlideRecord
    • VerlaufsWalker
    • NumberFormatter
    • openFrameAPI
    • PDAutomationProvider
    • PDFGenerationAPI
    • PlaybookExperience
    • Produktkatalog Open API
    • Serviceauftrags-OpenAPI
    Die folgenden APIs erfordern eine Plugin-Aktivierung:
    • Für die AWA-API für manuelle Zuweisungen muss das Plugin Erweiterte Arbeitszuweisung (com.glide.awa) aktiviert werden.
    • Für die PersonalAuthAPI muss das Plugin „Personal Authentication“ (com.snc.sn_ihub_personal_auth) aktiviert werden.
    • Für die API „ Aktive Einbindung “ muss das Plugin „Aktive Einbindung“ (proactive-engagement) aktiviert sein.
    • Für PSBPublicAPIUtil müssen die Plugins Service Bridge for Providers (sn_sb_pro) und Service Bridge Base (sn_sb) aktiviert sein.
    • Für die Resource Inventory Open API muss das Plugin „Customer Network Inventory Core“ (com.app-ni-core) aktiviert sein.
    • Für die Service Test Management Open API muss das Plugin „Customer Service Problem Management“ (com.sn_sprb_mgmt) aktiviert sein.
    • Für die WSD-API „Extra Service Request “ muss das Plugin „Management von Arbeitsplatz-Reservierungen“ (com.sn_wsd_rsv) aktiviert sein.
    • Für die WSD Reservable API muss das Plugin „Management von Arbeitsplatz-Reservierungen“ (com.sn_wsd_rsv) aktiviert sein.
    • Für die WSD Reservable V2- API muss das Plugin „Management von Arbeitsplatz-Reservierungen“ (com.sn_wsd_rsv) aktiviert sein.