Combined API release notes for upgrades from Vancouver to Xanadu

  • Release version: Yokohama
  • Updated January 30, 2026
  • 13 minutes to read

    • Consolidated page of all release notes for API from Vancouver to Xanadu.

    How to use this page

    To help you prepare for your upgrade, we have combined the cross-family API release notes onto one page. Read this summary of the new features, changes, and updated information for your product from Vancouver to Xanadu.

    Tip:
    If there were no updates for a release notes section in a certain family release, we included a short note for your reference. For example, if a product did not have any updates in Tokyo, the row says "No updates for this release."

    Important information for upgrading API to Xanadu

    Before you upgrade to Xanadu, review these pre- and post-upgrade tasks and complete the tasks as needed.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    New features

    Between your current release family and Xanadu, new features were introduced for API.

    Release Release notes

    Vancouver
    Table 1. New scoped classes and additional methods to existing scoped classes
    Class Methods
    DuplicateTemplate - Scoped
    • canAddTasksToTemplate()
    • createTemplate()
    • getTemplate()
    • previewTemplate()
    • publishTemplate()
    • remediateTask()
    • requestCancellation()
    • retireTemplate()
    • runTemplate()
    • unPublishTemplate()
    • updateTemplate()
    GeniusResultContext - Scoped getMatchingDocuments()
    GlideDBFunctionBuilder - Scoped, Global
    • andFunc()
    • orFunc()
    • compare()
    GlideElement - Scoped
    • getDisplayValueLang()
    • getLabelLang()
    GlideNumberFormatter API - Scoped, Global
    • formatLang()
    • format()
    GlideSPScriptable - Scoped isRTLEnabled()
    ProactiveTriggerAPI - Scoped
    • createTrigger()
    • process()
    • setTriggerRecord()
    • setUserId()
    • setUserName()
    • setUserSessionId()
    TransformerDefinition - Scoped, Global TransformerDefinition()
    Table 2. New global classes and additional methods to existing global classes
    Class Methods
    CMDBDuplicateTemplateUtil - Global
    • addTasksToTemplate()
    • CMDBDuplicateTemplate()
    • removeTemplateFromTask()
    GlideDBFunctionBuilder - Scoped, Global
    • andFunc()
    • orFunc()
    • compare()
    GlideDBFunctionCaseBuilder - Global
    • GlideDBFunctionCaseBuilder()
    • whenCompare()
    • whenEqual()
    • when()
    • then()
    • otherwise()
    • build()
    GlideElement - Global
    • getDisplayValueLang()
    • getLabelLang()
    GlideGeoPoint - Global
    • GlideGeoPoint()
    • setValue()
    • getValue()
    • getDisplayValue()
    • getLongitude()
    • getLatitude()
    GlideJsonPath - Global
    • GlideJsonPath()
    • read()
    GlideNumberFormatter API - Scoped, Global
    • formatLang()
    • format()
    Table 3. New client mobile APIs and additional methods to existing client mobile APIs
    Class Methods
    cabrillo.attachments - Client addFiles()
    cabrillo.nowapp - Client
    • openLauncherScreen()
    • openScreen()
    • openScreenWithRecordContext()
    • performFunction()
    • refresh()
    Table 4. New REST APIs and additional endpoints to existing REST APIs
    API Endpoints
    Install Base Item API
    • DELETE /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}
    • GET /sn_install_base/integrations/installbaseitems
    • GET /sn_install_base/integrations/installbaseitem/{id}
    • GET /sn_install_base/integrations/installbaseitems/{id}/cases
    • GET /sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems
    • GET /sn_install_base/integrations/installbaseitems/{id}/contracts
    • GET /sn_install_base/integrations/installbaseitems/{id}/entitlements
    • GET /sn_install_base/integrations/installbaseitems/{id}/maintenanceplans
    • GET /sn_install_base/integrations/installbaseitems/{id}/relatedparties
    • GET /sn_install_base/integrations/installbaseitems/{id}/soldproducts
    • GET /sn_install_base/integrations/installbaseitems/{id}/workorders
    • PATCH /sn_install_base/integrations/installbaseitems/{id}
    • PATCH /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}
    • PATCH /sn_install_base/integrations/installbaseitems/{id}/uninstall
    • POST /sn_install_base/integrations/installbaseitems
    • POST /sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Washington DC
    Table 5. New scoped classes and additional methods to existing scoped classes
    Class Methods
    GlideAggregate - Scoped setIntervalYearIncluded()
    GlideRecord - Scoped Scoped GlideRecord - updateWithReferences(Object reason)
    ProcessMiningForExternalData - Scoped, Global ProcessMiningForExternalData - scheduleCaseGeneration(String externalDataSysId)
    ProductInstance API - Scoped, Global
    XMLDocument2 - Scoped, Global setEnableCDATAReporting()
    XMLNode - Scoped, Global isCDATANode()
    Table 6. New global classes and additional methods to existing global classes
    Class Methods
    GlideAggregate - Global setIntervalYearIncluded()
    GlideRecord - Global GlideRecord - addExtraField(String dotWalkedField)
    OnCallContactPrefTemplate - Global
    OnCallEscalationTemplateSNC - Global
    ProcessMiningForExternalData - Scoped, Global ProcessMiningForExternalData - scheduleCaseGeneration(String externalDataSysId)
    ProductInstance API - Scoped, Global
    SPWidgetAccessControl - Global hasPublicAccess()
    XMLDocument2 - Scoped, Global setEnableCDATAReporting()
    XMLNode - Scoped, Global isCDATANode()
    Table 7. New REST APIs and endpoints available in the ServiceNow Store
    Application Version API Endpoints
    Threat Intelligence Security Center for Security Operations 3.0.2 TISC API POST /sn_sec_tisc/threat_intel_data/observables

    Xanadu
    Table 8. New scoped classes and additional methods to existing scoped classes in Xanadu
    Class Methods
    CMDBQBScopedScriptableAPI - Scoped
    • createReport()
    • deleteQuery()
    • getSavedQueryExecutionDetails()
    • saveQuery()
    • updateQuery()
    HistoryWalker - Scoped, Global walkTo(checkpoint)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDAutomationProvider - Scoped, Global
    • activateProcess()
    • deactivateProcess()
    • duplicateProcess()
    PDFGenerationAPI - Scoped, Global redact()
    PersonalAuthAPI - Scoped
    • PersonalAuthAPI()
    • getInitiatorURL()
    • isTokenValid()
    • revokeToken()
    PlaybookExperience - Scoped restartPlaybook()
    Table 9. New global classes and additional methods to existing global classes in Xanadu
    Class Methods
    CMDBQueryBuilderAPI - Global
    • createReport()
    • deleteQuery()
    • saveQuery()
    • updateQuery()
    DynamicSchemaAPI - Global
    • clearDynamicCategoryCache()
    • clearDynamicChoiceSetCache()
    • clearDynamicAttributeGroupCache()
    • clearDynamicAttributeGroupCacheItem()
    • clearDynamicCategoryCacheItem()
    • clearDynamicChoiceSetItem()
    • get()
    GlideAggregate - Global
    • getDynamicAttributeValue() - two signatures
    • getDynamicAttributeDisplayValue() - two 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() - two signatures
    • getDynamicAttributeValue() - two signatures
    • getDynamicAttributeDisplayValue() - two signatures
    • setDynamicAttributeValue() - two signatures
    • setDynamicAttributeDisplayValue() - two signatures
    • setDynamicAttributeValues()
    HistoryWalker - Scoped, Global walkTo(checkpoint)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDFGenerationAPI - Scoped, Global redact()
    Table 10. New client mobile APIs and additional methods to existing client mobile APIs in Xanadu
    Class Methods
    m_form - Client
    • addErrorMessage()
    • addInfoMessage()
    • getValue()
    • setAffectedInputs()
    • setValue()
    MobileScriptIncludeCaller - Client
    • MobileScriptIncludeCaller()
    • addParam()
    • call()

    Changes

    Between your current release family and Xanadu, some changes were made to existing API features.

    Release Release notes

    Vancouver
    Table 11. Changed scoped classes
    Class Methods
    GlideAggregate - Scoped The orderBy() method now accepts arguments that are glidefunctions.
    Table 12. Changed global classes
    Class Methods
    GlideAggregate - Global The orderBy() method now accepts arguments that are glidefunctions.

    Washington DC
    Table 13. Changed scoped classes
    Class Methods
    DecisionTableAPI - Scoped, Global The createAnswerElements() method now supports additional answer element types.
    • Due_date
    • Glide_date
    • Glide_date_time
    • Glide_duration
    • Longint
    GlideRecord - Scoped A new system property, glide.db.forced.chunk.threshold, allows the deleteMultiple() and updateMultiple() methods to force chunk record deletions and updates above a threshold.
    Table 14. Changed global classes
    Class Methods
    DecisionTableAPI - Scoped, Global The createAnswerElements() method now supports additional answer element types.
    • Due_date
    • Glide_date
    • Glide_date_time
    • Glide_duration
    • Longint
    GlideRecord - Global A new system property, glide.db.forced.chunk.threshold, allows the deleteMultiple() and updateMultiple() methods to force chunk record deletions and updates above a threshold.
    Table 15. Changed client APIs
    Class Methods
    GlideForm (g_form) - Client The addFormMessage() method has a new parameter options to add buttons to a form message.
    Table 16. Changed REST APIs
    API Endpoints
    System for Cross-domain Identity Management (SCIM) API The SCIM - PATCH /scim/Groups/{group_id} endpoint returns a new 204 status message when the SCIM UI property, Enable Group Patch API response with No Content, is successful.
    Table 17. Changed scoped classes available in the ServiceNow Store
    Application Version Class Methods
    Customer Service Management 2.0.0 LeadtoCashCore - Scoped
    Automated Test Framework 2.3.8 Cloud Runner TestGenerationApi – Scoped, Global TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email, Boolean separateUpdateSetPerScope, String scopeForGeneratingTests) - endpoint supports two new parameters, separateUpdatePerScope and scopeForGeneratingTests, which designate whether generated tests are separated into same or separate scopes.
    Table 18. Changed global classes available in the ServiceNow Store
    Application Version Class Methods
    Automated Test Framework 2.3.8 Cloud Runner TestGenerationApi – Scoped, Global The TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email, Boolean separateUpdateSetPerScope, String scopeForGeneratingTests) method supports the new separateUpdatePerScope parameter, which designates whether generated tests are separated into same or separate scopes.
    Table 19. Changed REST APIs available in the ServiceNow Store
    Application Version API Endpoints
    Automated Test Framework 2.3.8 Cloud Runner Test Generation REST API The Cloud Runner Test Generation - POST /now/sn_atf_tg/test_generation endpoint supports two new parameters, separateUpdatePerScope and scopeForGeneratingTests, which designate whether generated tests are separated into same or separate scopes.
    Order Management for Telecommunications, Media, and Technology 8.0.1 Product Order Open API A new system property, sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder, impacts how change orders are processed for the PATCH /sn_ind_tmt_orm/order/productOrder/{id} and POST /sn_ind_tmt_orm/order/productOrder endpoints. When the property is set to true (default), if the product inventory is a different version than indicated in the order, the product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed.
    Order Management for Telecommunications, Media, and Technology 8.0.1 Service Order Open API A new system property, sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder, impacts how change orders are processed for the PATCH /sn_ind_tmt_orm/order/serviceorder/{id} and POST /sn_ind_tmt_orm/serviceorder endpoints. When the property is set to true (default), if the service is a different version than indicated in the order, the service is automatically upgraded to the version in the order by changing the referenced service specification. This allows the order to be successfully processed.

    Xanadu
    Table 20. Changed scoped classes in Xanadu
    Class Methods
    HistoryWalker - Scoped, Global Added parameter for specifying the type of history walker implementation to use.

    HistoryWalker()
    Table 21. Changed global classes in Xanadu
    Class Methods
    GlideAggregate - Global Added support for dynamic schema.
    • addAggregate()
    • addHaving()
    • getValue()
    • groupBy()
    • orderBy()
    • orderByAggregate()
    GlideRecord - Global Added support for dynamic schema.
    • addQuery()
    • getDisplayValue()
    • getValue()
    • orderBy()
    • orderByDesc()
    • setDisplayValue()
    • setValue()
    HistoryWalker - Scoped, Global Added parameter for specifying the type of history walker implementation to use.

    HistoryWalker()
    Table 22. Changed REST APIs in Xanadu
    Class Methods
    AWA Manual Assignment API Added new request body parameters.

    POST /awa/workitems/{work_item_sys_id}/assignments
    Continuous Integration/Continuous Delivery (CICD) API Added new optional query parameters for specifying whether to run a test suite as a performance test and in Cloud Runner.

    POST /sn_cicd/testsuite/run
    Table 23. Changed scoped classes in the ServiceNow store
    Application App version Class Methods
    Lead to Cash Core V1.3.1 LeadtoCashCore - Scoped The LeadtoCashCore script include is enhanced to support reconfiguration use cases:
    • createInstance() - Returns _state identifying whether the entity record is in an active or inactive state.
    • delta() - additionalParams now supports the ability to ignore attributes to compare in source and dirtyJSONs.
    • effect() - additionalParams now supports the ability to provide context variable keys instead of dictionary field names. Additionally, effect() returns the _state parameter identifying whether the entity record is in an active or inactive state.
    Lead to Cash Core V2.0.0 LeadtoCashCore - Scoped commitInstance() now returns the dataObject object which displays the status of an asynchronous transaction for users to review and submit the transaction for further fulfillment.
    Table 24. Changed client APIs in the ServiceNow store
    Class Methods
    CSM Openframe V1.0 openFrameAPI - Client Added workitem_rejected and workitem_accepted response payloads.

    subscribe()
    CSM Openframe V1.1 openFrameAPI - Client Added isAutoAccepted flag in response payloads.

    subscribe()
    Table 25. Changed REST APIs in the ServiceNow store
    Application App version Class Methods
    Customer Contracts and Entitlements V4.0 Service Contract API Product specification information and automatically generated identification number were added to the following endpoints:
    • GET /sn_pss_core/servicecontract/{id}
    • GET /sn_pss_core/servicecontract/contractline/{id}
    • POST /sn_pss_core/servicecontract
    • POST /sn_pss_core/servicecontract/contractline
    Entitlements Verification V2.0 Verify Entitlements API Product specification information and automatically generated identification number were added to the following endpoints:
    • GET /sn_ent_verify/verifyentitlements
    • GET /sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{id}
    Telecommunication Open APIs V2.1.0 Service Order Open API
    • For all endpoints, the namespace and endpoint paths changed from sn_ind_tmt_ord to sn_tmf_api.
    • The following methods return two new parameters, href and orderDate.
      • GET /sn_tmf_api/order/serviceOrder
      • POST /sn_tmf_api/order/serviceOrder/cancelserviceorder
      • Service Order Open API – POST /sn_tmf_api/order/serviceOrder
      • POST /sn_tmf_api/order/serviceOrder/outboundresponse
    Telecommunication Open APIs V2.1.0 Product Catalog Open API
    • For all endpoints, the namespace and endpoint paths changed from sn_ind_tmt_ord to sn_tmf_api.
    • productOffering methods return two new optional parameters, href and lifecycleStatus:
      • 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
    • productSpecification methods return three new optional parameters, isBundle, href, and lifecycleStatus:
      • 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
    Threat Intelligence Security Center for Security Operations V3.5.0 TISC API The sort_by and sort_direction request body parameters are no longer supported. Observables returned in the response are sorted by sys_id in ascending order.

    POST /sn_sec_tisc/threat_intel_data/observables
    Workplace Reservation Management WSD Extra Service Request API Added new request body parameter, reservationDateTimeChanged.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    Workplace Reservation Management V2.11.0 WSD Reservable API Added new query parameter, reservation_start_time.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    Workplace Reservation Management V2.11.0 WSD Reservable V2 API Added new query parameter, reservation_start_time.

    POST /sn_wsd_rsv/v2/reservable/list_reservables

    Removed

    Between your current release family and Xanadu, some API features or functionality were removed.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Deprecations

    Between your current release family and Xanadu, some API features or functionality were deprecated.

    Release Release notes

    Vancouver

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Activation information

    Review information on how to activate API.

    Release Release notes

    Vancouver
    The following APIs are available by default:
    • Cabrillo.Attachments
    • CMDBDuplicateTemplateUtils
    • DuplicateTemplate
    • GlideAggregate
    • GlideElement
    • GlideJsonPath
    • GlideNumberFormatter
    • GlideDBFunctionCaseBuilder
    • GlideSPScriptable
    • ProactiveTriggerAPI
    The following APIs require plugin activation:
    • The Install Base Item API requires the Customer Service Install Base Management (com.snc.install_base) plugin to be activated.
    • The OnCallContactPrefTemplate and OnCallEscalationTemplateSNC APIs require the On-Call Scheduling (com.snc.on_call_rotation) plugin to be activated.
    • The TransformerDefinition API requires the Transformation Service (com.glide.transform) plugin to be activated.

    Washington DC
    The following APIs are available by default:
    • DecisionTableAPI
    • DuplicateTemplate
    • GlideAggregate
    • GlideForm
    • GlideRecord
    • ProductInstance
    • SPWidgetAccessControl
    • XMLDocument2
    • XMLNode
    The following APIs require plugin activation:
    • The OnCallContactPrefTemplate and OnCallEscalationTemplateSNC APIs require the On-Call Scheduling (com.snc.on_call_rotation) plugin to be activated.
    • The ProcessMiningForExternalData API requires the Process Mining for external data (sn_po_extdata) plugin to be activated.

    Xanadu
    The following APIs are available by default:
    • Cloud Services Catalog API
    • DynamicSchemaAPI
    • GlideAggregate
    • GlideDate
    • GlideDynamicAttributeStore
    • GlideElementAttributeStore
    • GlideRecord
    • HistoryWalker
    • NumberFormatter
    • openFrameAPI
    • PDAutomationProvider
    • PDFGenerationAPI
    • PlaybookExperience
    • Product Catalog Open API
    • Service Order Open API
    The following APIs require plugin activation:
    • The Appointment Open API requires the following plugins to be activated:
      • Appointment Booking (com.snc.appointment_booking)
      • Field Service Management (com.snc.work_management)
      • Field Service Management for Telecommunications (com.sn_fsmt)
      • Telecommunication Open APIs (com.sn_tmf_api)
    • The AWA Manual Assignment API requires the Advanced Work Assignment (com.glide.awa) plugin to be activated.
    • The LeadtoCashCore script include requires the Lead to Cash Core (com.snd.l2c.core) plugin to be activated.
    • The PersonalAuthAPI requires the Personal Authentication (com.snc.sn_ihub_personal_auth) plugin to be activated.
    • The Proactive Engagement API requires the Proactive Engagement (proactive-engagement) plugin to be activated.
    • The PSBPublicAPIUtil requires the for Providers application (sn_sb_pro) and the Base (sn_sb) plugins to be activated.
    • The Resource Inventory Open API requires the Customer Network Inventory Core application (com.app-ni-core) plugin to be activated.
    • The Service Contract API requires the following plugins to be activated:
      • Customer Contracts and Entitlements (com.sn_pss_core)
      • Customer Service Install Base Management (com.snc.install)
      • Product Catalog Management Core (com.sn_prd)
    • The Service Test Management Open API requires the Customer Service Problem Management (com.sn_sprb_mgmt) plugin to be activated.
    • The Verify Entitlements API requires the Entitlement Verification (sn_ent_verify) plugin to be activated.
    • The WSD Extra Service Request API requires the Workplace Reservation Management (com.sn_wsd_rsv) plugin to be activated.
    • The WSD Reservable API requires the Workplace Reservation Management (com.sn_wsd_rsv) plugin to be activated.
    • The WSD Reservable V2 API requires the Workplace Reservation Management (com.sn_wsd_rsv) plugin to be activated.

    Additional requirements

    If any additional requirements were introduced or changed for API we have noted them here.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Browser requirements

    If any specific browser requirements were introduced or changed for API we have noted them here.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Accessibility information

    Review details on accessibility information for API, such as specific requirements or compliance levels.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Localization information

    If there are specific localization considerations for API we have noted them here.

    Release Release notes

    Vancouver

    		 No updates for this release.

    Washington DC

    		 No updates for this release.

    Xanadu

    		 No updates for this release.

    Highlight information

    If there are specific highlight considerations for API we have noted them here.

    Release Release notes

    Vancouver
    • Use server-side JavaScript APIs in scripts to change the application functionality.
    • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
    • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.

    See API implementation and reference for more information.

    Washington DC
    • Use server-side JavaScript APIs in scripts to change the application functionality.
    • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
    • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.

    See API implementation and reference for more information.

    Xanadu
    • Use server-side JavaScript APIs in scripts to change the application functionality.
    • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
    • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.

    See API implementation and reference for more information.