---
sourceDocument: zurich Combined Product Files
sourceDocumentLink: https://www.servicenow.com/docs/r/zurich/delta-xanadu-zurich

 Release :

    - zurich

ft:locale :

    - en-US

ft:publication_title :

    - zurich Combined Product Files

ft:clusterId :

    - delta3zx

bundleId :

    - delta3zx


---

# Combined API release notes for upgrades from Xanadu to Zurich

# Combined API release notes for upgrades from Xanadu to Zurich {#ariaid-title1}

Release version: Zurich  
Updated October 8, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 16 minutes to read  
Consolidated page of all release notes for API from Xanadu to Zurich.

## 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 Xanadu to Zurich.  
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 Zurich

Before you upgrade to Zurich, review these pre- and post-upgrade tasks and complete the tasks as needed.  
{#dfrn3-api-summary__entry__2}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## New features

Between your current release family and Zurich, new features were introduced for API.  
{#dfrn3-api-summary__entry__10}

| Release | Release notes |
|-|-|
| Xanadu | {#dfrn3-api-summary__entry__14} | Class | Methods | |-|-| | [CMDBQBScopedScriptableAPI - Scoped](https://www.servicenow.com/docs/access?context=CMDBQBScopedAPI&family=xanadu&ft:locale=en-US) | * createReport() * deleteQuery() * getSavedQueryExecutionDetails() * saveQuery() * updateQuery() | | [HistoryWalker - Scoped, Global](https://www.servicenow.com/docs/access?context=HistoryWalkerScopedAPI&family=xanadu&ft:locale=en-US) | walkTo(checkpoint) | | [NumberFormatter - Scoped, Global](https://www.servicenow.com/docs/access?context=NumberFormatterBoth&family=xanadu&ft:locale=en-US) | * parseWithLocale() * parseWithSeparators() | | [PDAutomationProvider - Scoped, Global](https://www.servicenow.com/docs/access?context=PDAutomationProviderBothAPI&family=xanadu&ft:locale=en-US) | * activateProcess() * deactivateProcess() * duplicateProcess() | | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=xanadu&ft:locale=en-US) | redact() | | [PersonalAuthAPI - Scoped](https://www.servicenow.com/docs/access?context=PersonalAuthAPIScoped&family=xanadu&ft:locale=en-US) | * PersonalAuthAPI() * getInitiatorURL() * isTokenValid() * revokeToken() | | [PlaybookExperience - Scoped](https://www.servicenow.com/docs/access?context=PlaybookExperienceScopedAPI&family=xanadu&ft:locale=en-US) | restartPlaybook() | [Table 1. New scoped classes and additional methods to existing scoped classes in Xanadu] {#dfrn3-api-summary__entry__30} | Class | Methods | |-|-| | [CMDBQueryBuilderAPI - Global](https://www.servicenow.com/docs/access?context=CMDBQueryBuilderAPI&family=xanadu&ft:locale=en-US) | * createReport() * deleteQuery() * saveQuery() * updateQuery() | | [DynamicSchemaAPI - Global](https://www.servicenow.com/docs/access?context=DynamicSchemaAPI&family=xanadu&ft:locale=en-US) | * clearDynamicCategoryCache() * clearDynamicChoiceSetCache() * clearDynamicAttributeGroupCache() * clearDynamicAttributeGroupCacheItem() * clearDynamicCategoryCacheItem() * clearDynamicChoiceSetItem() * get() | | [GlideAggregate - Global](https://www.servicenow.com/docs/access?context=c_GlideAggregateAPI&family=xanadu&ft:locale=en-US) | * getDynamicAttributeValue() - two signatures * getDynamicAttributeDisplayValue() - two signatures | | [GlideDate - Global](https://www.servicenow.com/docs/access?context=GlideDateAPI&family=xanadu&ft:locale=en-US) | parseDate() | | [GlideDynamicAttributeStore - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttStoreAPI&family=xanadu&ft:locale=en-US) | * clear() * getDisplayValue() * getValue() * setDisplayValue() * setDynamicAttributeDisplayValue() * setDynamicAttributeValue() * setDynamicAttributeValues() * setValue() * toString() | | [GlideElementDynamicAttributeStore - Global](https://www.servicenow.com/docs/access?context=GlideElementDynamicAttStoreAPI&family=xanadu&ft:locale=en-US) | * getDynamicAttribute() * getDynamicAttributeDisplayValue() * getDynamicAttributeValue() * setDynamicAttributeValue() * setDynamicAttributeValues() * setDynamicAttributeDisplayValue() * setDynamicAttributeDisplayValues() | | [GlideRecord - Global](https://www.servicenow.com/docs/access?context=c_GlideRecordAPI&family=xanadu&ft:locale=en-US) | * getDynamicAttribute() - two signatures * getDynamicAttributeValue() - two signatures * getDynamicAttributeDisplayValue() - two signatures * setDynamicAttributeValue() - two signatures * setDynamicAttributeDisplayValue() - two signatures * setDynamicAttributeValues() | | [HistoryWalker - Scoped, Global](https://www.servicenow.com/docs/access?context=HistoryWalkerScopedAPI&family=xanadu&ft:locale=en-US) | walkTo(checkpoint) | | [NumberFormatter - Scoped, Global](https://www.servicenow.com/docs/access?context=NumberFormatterBoth&family=xanadu&ft:locale=en-US) | * parseWithLocale() * parseWithSeparators() | | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=xanadu&ft:locale=en-US) | redact() | [Table 2. New global classes and additional methods to existing global classes in Xanadu] {#dfrn3-api-summary__entry__52} | Class | Methods | |-|-| | [m_form - Client](https://www.servicenow.com/docs/access?context=m_formClientAPI&family=xanadu&ft:locale=en-US) | * addErrorMessage() * addInfoMessage() * getValue() * setAffectedInputs() * setValue() | | [MobileScriptIncludeCaller - Client](https://www.servicenow.com/docs/access?context=MobileScriptInclCallerClientAPI&family=xanadu&ft:locale=en-US) | * MobileScriptIncludeCaller() * addParam() * call() | [Table 3. New client mobile APIs and additional methods to existing client mobile APIs in Xanadu] |
| Yokohama | {#dfrn3-api-summary__entry__60} | Class | Methods | |-|-| | [Console - Scoped, Global](https://www.servicenow.com/docs/access?context=ConsoleAPI&family=yokohama&ft:locale=en-US) | * error() * group() * groupCollapsedString() * groupEnd() * info() * log() * table() * time() * timeEnd() * timeLog() * trace() * warn() | | [Fetch - Scoped, Global](https://www.servicenow.com/docs/access?context=FetchAPI&family=yokohama&ft:locale=en-US) | fetch() | | [Fetch Headers - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.HeadersAPI&family=yokohama&ft:locale=en-US) | * Headers() * append() * delete() * entries() * forEach() * get() * getSetCookie() * has() * keys() * set() * values() | | [Fetch Request - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.RequestAPI&family=yokohama&ft:locale=en-US) | * Request() * arrayBuffer() * blob() * bytes() * clone() * formData() * json() * text() | | [Fetch RequestInit - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.RequestInitAPI&family=yokohama&ft:locale=en-US) | requestInit() | | [Fetch Response - Scoped,Global](https://www.servicenow.com/docs/access?context=Fetch.ResponseAPI&family=yokohama&ft:locale=en-US) | * arrayBuffer() * blob() * bytes() * formData() * json() * text() | | [GlideUser - Scoped](https://www.servicenow.com/docs/access?context=c_GlideUserScopedAPI&family=yokohama&ft:locale=en-US) | * getTimeZoneLabel() * getTimeZoneLabelLang() | | [OrderUtil - Scoped](https://www.servicenow.com/docs/access?context=OrderUtilScopedAPI&family=yokohama&ft:locale=en-US) | * getStateFromOrder() * isOrderInDraftState() | | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=yokohama&ft:locale=en-US) | * convertToPDFAsync() * convertToPDFWithHeaderFooterAsync() | | [ProcessMiningIntegrationAPI - Scoped](https://www.servicenow.com/docs/access?context=ProcessMiningIntAPIScoped&family=yokohama&ft:locale=en-US) | * createProject() * deleteProject() * getBreakDownStats() * getFindings() * getMiningStatus() * getProject() * scheduleMining() | | [RESTMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_RESTMessageV2API&family=yokohama&ft:locale=en-US) | setAllowedRedirectURIs() | | [SOAPMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_SOAPMessageV2API&family=yokohama&ft:locale=en-US) | * setAllowedRedirectURIs() * setFollowRedirect() | | [UriMatcher - Scoped](https://www.servicenow.com/docs/access?context=UriMatcherScopedAPI&family=yokohama&ft:locale=en-US) | * UriMatcher() * match() | | [UriMatcherResponse - Scoped](https://www.servicenow.com/docs/access?context=UriMatcherResponseScopedAPI&family=yokohama&ft:locale=en-US) | * getErrorMessages() * isError() * isFragmentMatches() * isHostMatches() * isMatch() * isPathMatches() * isSchemeMatches() | | [v_record - Scoped, Global](https://www.servicenow.com/docs/access?context=v_recordAPI&family=yokohama&ft:locale=en-US) | setLastErrorMessage() | [Table 4. New scoped classes and additional methods to existing scoped classes in Yokohama] {#dfrn3-api-summary__entry__92} | Class | Methods | |-|-| | [Console - Scoped, Global](https://www.servicenow.com/docs/access?context=ConsoleAPI&family=yokohama&ft:locale=en-US) | * error() * group() * groupCollapsedString() * groupEnd() * info() * log() * table() * time() * timeEnd() * timeLog() * trace() * warn() | | [Fetch - Scoped, Global](https://www.servicenow.com/docs/access?context=FetchAPI&family=yokohama&ft:locale=en-US) | fetch() | | [Fetch Headers - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.HeadersAPI&family=yokohama&ft:locale=en-US) | * Headers() * append() * delete() * entries() * forEach() * get() * getSetCookie() * has() * keys() * set() * values() | | [Fetch Request - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.RequestAPI&family=yokohama&ft:locale=en-US) | * Request() * arrayBuffer() * blob() * bytes() * clone() * formData() * json() * text() | | [Fetch RequestInit - Scoped, Global](https://www.servicenow.com/docs/access?context=Fetch.RequestInitAPI&family=yokohama&ft:locale=en-US) | requestInit() | | [Fetch Response - Scoped,Global](https://www.servicenow.com/docs/access?context=Fetch.ResponseAPI&family=yokohama&ft:locale=en-US) | * arrayBuffer() * blob() * bytes() * formData() * json() * text() | | [GlideDynamicAttribute - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttributeAPI&family=yokohama&ft:locale=en-US) | * getSysId() * getName() * getType() * getGroupName() * getPath() * isTransient() | | [GlideDynamicAttributeStore - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttStoreAPI&family=yokohama&ft:locale=en-US) | getDynamicAttributes() | | [GlideElementDynamicAttributeStore - Global](https://www.servicenow.com/docs/access?context=GlideElementDynamicAttStoreAPI&family=yokohama&ft:locale=en-US) | * getDynamicAttributesInSchema() * getDynamicAttributesInStore() | | [GlideTransientDynamicAttribute - Global](https://www.servicenow.com/docs/access?context=GlideTransientDynamicAttributeAPI&family=yokohama&ft:locale=en-US) | * getSysId() * getName() * getType() * getGroupName() * getPath() * isTransient() | | [GlideUser - Global](https://www.servicenow.com/docs/access?context=GUserAPI&family=yokohama&ft:locale=en-US) | * getTimeZoneLabel() * getTimeZoneLabelLang() | | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=yokohama&ft:locale=en-US) | * convertToPDFAsync() * convertToPDFWithHeaderFooterAsync() | | [RESTMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_RESTMessageV2API&family=yokohama&ft:locale=en-US) | setAllowedRedirectURIs() | | [SOAPMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_SOAPMessageV2API&family=yokohama&ft:locale=en-US) | * setAllowedRedirectURIs() * setFollowRedirect() | [Table 5. New global classes and additional methods to existing global classes in Yokohama] {#dfrn3-api-summary__entry__122} | API | Endpoints | |-|-| | [AWA Offer Work API](https://www.servicenow.com/docs/access?context=awa-offer-work-api&family=yokohama&ft:locale=en-US) | POST /now/awa/documents/{document_table}/{document_sys_id}/offer | | [Continuous Integration and Continuous Delivery (CICD) Update Set API](https://www.servicenow.com/docs/access?context=cicd-update-set-api&family=yokohama&ft:locale=en-US) | * POST /sn_cicd/update_set/retrieve * POST /sn_cicd/update_set/commitMultiple * POST /sn_cicd/update_set/preview/{remote_update_set_id} * POST /sn_cicd/update_set/back_out * POST /sn_cicd/update_set/commit/{remote_update_set_id} * POST /sn_cicd/update_set/create | [Table 6. New REST APIs and additional endpoints to existing REST APIs in Yokohama] |
| Zurich | {#dfrn3-api-summary__entry__130} | Class | Methods | |-|-| | [GlideCurrencyCode - Scoped, Global](https://www.servicenow.com/docs/access?context=GlideCurrencyCodeBothAPI&family=zurich&ft:locale=en-US) | * getCurrencyCode() * getNumericCurrencyCode() | | [GlideCurrencySymbol - Scoped, Global](https://www.servicenow.com/docs/access?context=GlideCurrencySymbolBothAPI&family=zurich&ft:locale=en-US) | * getCurrencySymbol() * getSortedActiveCurrencySymbols() | | [GlideQueryCondition - Scoped](https://www.servicenow.com/docs/access?context=c_GlideQueryConditionScopedAPI&family=zurich&ft:locale=en-US) | * addSystemCondition * addSystemOrCondition * addUserCondition * addUserOrCondition | | [GlideRecord - Scoped](https://www.servicenow.com/docs/access?context=c_GlideRecordScopedAPI&family=zurich&ft:locale=en-US) | * addSystemEncodedQuery() * addSystemQuery() * addSystemOrderBy() * addSystemOrderByDesc() * addUserEncodedQuery() * addUserQuery() * addUserOrderBy() * addUserOrderByDesc() | | [GlideSysAttachment - Scoped](https://www.servicenow.com/docs/access?context=c_GlideSysAttachmentScopedAPI&family=zurich&ft:locale=en-US) | * addAttribute() * addMultipleAttributes() * deleteAllAttributes() * deleteAttribute() * fetchAllAttributes() * fetchAttribute() * updateAllAttributes() * updateAttribute() | | [GlideSystem - Scoped](https://www.servicenow.com/docs/access?context=c_GlideSystemScopedAPI&family=zurich&ft:locale=en-US) | Added support for additional message types to display at the top of forms: * addHighMessage() * addLowMessage() * addSuccessMessage() * addModerateMessage() | [Table 7. New scoped classes and additional methods to existing scoped classes in Zurich] {#dfrn3-api-summary__entry__144} | Class | Methods | |-|-| | [GlideDynamicAttribute - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttributeAPI&family=zurich&ft:locale=en-US) | Updated content to remove support for dynamic attribute groups. New method getNamespaceName(). | | [GlideDynamicAttributeStore - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttStoreAPI&family=zurich&ft:locale=en-US) | Updated content to remove support for dynamic attribute groups. New methods: * getDynamicNamespace() * setDynamicNamespace() | | [GlideDynamicNamespace - Global](https://www.servicenow.com/docs/access?context=GlideDynamicNamespaceAPI&family=zurich&ft:locale=en-US) | * getName() * isActive() * isTransient() | | [GlideQueryCondition - Global](https://www.servicenow.com/docs/access?context=c_GlideQueryConditionAPI&family=zurich&ft:locale=en-US) | * addSystemCondition * addSystemOrCondition * addUserCondition * addUserOrCondition | | [GlideRecord - Global](https://www.servicenow.com/docs/access?context=c_GlideRecordAPI&family=zurich&ft:locale=en-US) | * addSystemEncodedQuery() * addSystemQuery() * addSystemOrderBy() * addSystemOrderByDesc() * addUserEncodedQuery() * addUserQuery() * addUserOrderBy() * addUserOrderByDesc() | | [GlideSysAttachment - Global](https://www.servicenow.com/docs/access?context=GlideSysAttachmentGlobalAPI&family=zurich&ft:locale=en-US) | * addAttribute() * addMultipleAttributes() * deleteAllAttributes() * deleteAttribute() * fetchAllAttributes() * fetchAttribute() * updateAllAttributes() * updateAttribute() | | [GlideSystem - Global](https://www.servicenow.com/docs/access?context=c_GlideSystemAPI&family=zurich&ft:locale=en-US) | Added support for additional message types to display at the top of forms: * addHighMessage() * addLowMessage() * addModerateMessage() * addSuccessMessage() | | [Message - Global](https://www.servicenow.com/docs/access?context=sn_i18n.messageAPI&family=zurich&ft:locale=en-US) | Retrieves localized messages from the Message \[sys_ui_message\] table. It supports internationalization (i18n) by dynamically fetching messages based on the user's session language or a specified language parameter. * getMessage() * getMessageLang() | [Table 8. New global classes and additional methods to existing global classes in Zurich] {#dfrn3-api-summary__entry__162} | Class | Methods | |-|-| | [GlideForm (g_form) - Client](https://www.servicenow.com/docs/access?context=c_GlideFormAPI&family=zurich&ft:locale=en-US) | * 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](https://www.servicenow.com/docs/access?context=GModClientAPINX&family=zurich&ft:locale=en-US) | * destroy() * get() * getID() * getPreference() * getPreferences() * renderWithContent(Object) * renderWithContent(String) * setDialog() * setPreference() * setTitle() * type() | | [GlideNavigation (Next Experience) - Client](https://www.servicenow.com/docs/access?context=GlideNavigationClientAPINX&family=zurich&ft:locale=en-US) | refreshNavigator() | | [StopWatch (Next Experience) - Client](https://www.servicenow.com/docs/access?context=StopWatchAPINX&family=zurich&ft:locale=en-US) | * StopWatch() * getTime() * restart() * toString() | | [GlideForm (Next Experience) - Client](https://www.servicenow.com/docs/access?context=GlideFormAPINX&family=zurich&ft:locale=en-US) | * addChoice() * addHighMessage() * addLowMessage() * addModerateMessage() * addSuccessMessage() * clearChoices() * disableChoice() * enableChoice() * getAnnotationByName() * getAnnotations() * getChoice() * getOptions() * hideAnnotation() * removeChoice() * setChoiceLabel() * showAnnotation() * toggleAnnotations() | | [GlideUser (Next Experience) - Client](https://www.servicenow.com/docs/access?context=GlideUserAPINX&family=zurich&ft:locale=en-US) | getRoles() | [Table 9. New client classes and additional methods to existing client classes in Zurich] {#dfrn3-api-summary__entry__176} | API | Endpoints | |-|-| | [Conversation Member API](https://www.servicenow.com/docs/access?context=conversation-member-api&family=zurich&ft:locale=en-US) | * PUT now/conversation/member/{user_id}/drop * PUT now/conversation/member/{user_id}/update | | [Omnichannel Callback API](https://www.servicenow.com/docs/access?context=omichannel-callback-api&family=zurich&ft:locale=en-US) | * POST /api/sn_omni_callback/callback/attempt * POST /api/sn_omni_callback/callback/create * PATCH /api/sn_omni_callback/callback/update | | [CSM Pricing API](https://www.servicenow.com/docs/access?context=csm-pricing-api&family=zurich&ft:locale=en-US) | * POST /api/sn_csm_pricing/pricingengine/computePrice * DELETE /api/sn_csm_pricing/pricingengine/pricing_context/{pricing_context_id} | [Table 10. New REST APIs and additional endpoints to existing REST APIs in Zurich] |
[ ]

## Changes

Between your current release family and Zurich, some changes were made to existing API features.  
{#dfrn3-api-summary__entry__184}

| Release | Release notes |
|-|-|
| Xanadu | {#dfrn3-api-summary__entry__188} | Class | Methods | |-|-| | [HistoryWalker - Scoped, Global](https://www.servicenow.com/docs/access?context=HistoryWalkerScopedAPI&family=xanadu&ft:locale=en-US) | Added parameter for specifying the type of history walker implementation to use. HistoryWalker() | [Table 11. Changed scoped classes in Xanadu] {#dfrn3-api-summary__entry__192} | Class | Methods | |-|-| | [GlideAggregate - Global](https://www.servicenow.com/docs/access?context=c_GlideAggregateAPI&family=xanadu&ft:locale=en-US) | Added support for dynamic schema. * addAggregate() * addHaving() * getValue() * groupBy() * orderBy() * orderByAggregate() | | [GlideRecord - Global](https://www.servicenow.com/docs/access?context=c_GlideRecordAPI&family=xanadu&ft:locale=en-US) | Added support for dynamic schema. * addQuery() * getDisplayValue() * getValue() * orderBy() * orderByDesc() * setDisplayValue() * setValue() | | [HistoryWalker - Scoped, Global](https://www.servicenow.com/docs/access?context=HistoryWalkerScopedAPI&family=xanadu&ft:locale=en-US) | Added parameter for specifying the type of history walker implementation to use. HistoryWalker() | [Table 12. Changed global classes in Xanadu] {#dfrn3-api-summary__entry__200} | Class | Methods | |-|-| | [AWA Manual Assignment API](https://www.servicenow.com/docs/access?context=awa_manual_assign-api&family=xanadu&ft:locale=en-US) | Added new request body parameters. POST /awa/workitems/{work_item_sys_id}/assignments | | [Continuous Integration/Continuous Delivery (CICD) API](https://www.servicenow.com/docs/access?context=cicd-api&family=xanadu&ft:locale=en-US) | 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 13. Changed REST APIs in Xanadu] {#dfrn3-api-summary__entry__208} | Application | App version | Class | Methods | |-|-|-|-| | Lead to Cash Core | V1.3.1 | [LeadtoCashCore - Scoped](https://www.servicenow.com/docs/access?context=LeadToCashCoreAPI&family=xanadu&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=LeadToCashCoreAPI&family=xanadu&ft:locale=en-US) | 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 14. Changed scoped classes in the ServiceNow store] {#dfrn3-api-summary__entry__220} |   |   | Class | Methods | |-|-|-|-| | CSM Openframe | V1.0 | [openFrameAPI - Client](https://www.servicenow.com/docs/access?context=c_openFrameAPI&family=xanadu&ft:locale=en-US) | Added workitem_rejected and workitem_accepted response payloads. subscribe() | | CSM Openframe | V1.1 | [openFrameAPI - Client](https://www.servicenow.com/docs/access?context=c_openFrameAPI&family=xanadu&ft:locale=en-US) | Added isAutoAccepted flag in response payloads. subscribe() | [Table 15. Changed client APIs in the ServiceNow store] {#dfrn3-api-summary__entry__232} | Application | App version | Class | Methods | |-|-|-|-| | Customer Contracts and Entitlements | V4.0 | [Service Contract API](https://www.servicenow.com/docs/access?context=servicecontract-api&family=xanadu&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=verifyentitlements-api&family=xanadu&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=service-order-open-api&family=xanadu&ft:locale=en-US) | * 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](https://www.servicenow.com/docs/access?context=product-catalog-open-api&family=xanadu&ft:locale=en-US) | * 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](https://www.servicenow.com/docs/access?context=tisc-api&family=xanadu&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=wsd_extra_serv_req-api&family=xanadu&ft:locale=en-US) | Added new request body parameter, reservationDateTimeChanged. GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids} | | Workplace Reservation Management | V2.11.0 | [WSD Reservable API](https://www.servicenow.com/docs/access?context=wsd_reservable-api&family=xanadu&ft:locale=en-US) | 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](https://www.servicenow.com/docs/access?context=wsd_reservable-V2-api&family=xanadu&ft:locale=en-US) | Added new query parameter, reservation_start_time. POST /sn_wsd_rsv/v2/reservable/list_reservables | [Table 16. Changed REST APIs in the ServiceNow store] |
| Yokohama | {#dfrn3-api-summary__entry__268} | Class | Methods | |-|-| | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=yokohama&ft:locale=en-US) | * convertToPDF() * convertToPDFWithHeaderFooter() New properties, glide.pdf.url.whitelisting.enabled and com.snc.pdf.whitelisted_urls, have been added to ensure whether external URLs provided should be rendered in the PDF output. A new property, accessibilityEnabled, has been added for PDF accessibility support. | [Table 17. Changed scoped classes in Yokohama] {#dfrn3-api-summary__entry__272} | Class | Methods | |-|-| | [PDFGenerationAPI - Scoped, Global](https://www.servicenow.com/docs/access?context=PDFGenerationAPIBothAPI&family=yokohama&ft:locale=en-US) | * convertToPDF() * convertToPDFWithHeaderFooter() New properties, glide.pdf.url.whitelisting.enabled and com.snc.pdf.whitelisted_urls, have been added to ensure whether external URLs provided should be rendered in the PDF output. A new property, accessibilityEnabled, has been added for PDF accessibility support. | [Table 18. Changed global classes in Yokohama] {#dfrn3-api-summary__entry__276} | API | Endpoints | |-|-| | [Attachment API](https://www.servicenow.com/docs/access?context=c_AttachmentAPI&family=yokohama&ft:locale=en-US) | POST /now/attachment/file: A new parameter, creation_time, can be used to capture attachment creation times when the Now Mobile app is offline and the attachment is uploaded to a record at a later time. | [Table 19. Changed REST APIs in Yokohama] |
| Zurich | {#dfrn3-api-summary__entry__282} | Class | Methods | |-|-| | [GlideSysAttachment - Scoped](https://www.servicenow.com/docs/access?context=c_GlideSysAttachmentScopedAPI&family=zurich&ft:locale=en-US) | Support for copying any attributes from source attachment records and deleting attributes with attachments. * copy() * copy(targetFieldName) * copyAttachmentsByFieldNames() * deleteAllAttachment() * deleteAttachment() | | [IdentificationEngine - Scoped](https://www.servicenow.com/docs/access?context=IdentificationEngineScopedAPI&family=zurich&ft:locale=en-US) | Enable the referenceItems properties of the incoming payload to be populated before identifying a CI using the IRE rules defined on a class. * createOrUpdateCI() * createOrUpdateCIEnhanced() * identifyCIEnhanced() | | [ProducerV2 - Scoped](https://www.servicenow.com/docs/access?context=ProducerV2ScopedAPI&family=zurich&ft:locale=en-US) | send() - Added a return value and error handling. | | [RESTMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_RESTMessageV2API&family=zurich&ft:locale=en-US) | setHttpMethod() - Added support for HEAD method calls via the method parameter. | [Table 20. Changed scoped classes in Zurich] {#dfrn3-api-summary__entry__292} | Class | Methods | |-|-| | [GlideAggregate - Global](https://www.servicenow.com/docs/access?context=c_GlideAggregateAPI&family=zurich&ft:locale=en-US) | Remove support for groups in Dynamic Schema. * addAggregate() * addHaving() * getDynamicAttributeValue() * getDynamicAttributeDisplayValue() * getValue() * groupBy() * orderBy() * orderByAggregate() | | [GlideDynamicAttribute - Global](https://www.servicenow.com/docs/access?context=GlideDynamicAttributeAPI&family=zurich&ft:locale=en-US) | Remove support for groups in Dynamic Schema. * getGroupName() * getName() * getPath() * getType() * isTransient() Remove getSysId(). Remove GlideTransientDynamicAttribute API documentation because GlideDynamicAttribute and GlideTransientDynamicAttribute APIs provide the same solution. | | [GlideRecord - Global](https://www.servicenow.com/docs/access?context=c_GlideRecordAPI&family=zurich&ft:locale=en-US) | Remove support for groups in Dynamic Schema. * addQuery() * getDisplayValue() * getDynamicAttribute() * getDynamicAttributeDisplayValue() * getDynamicAttributeValue() * getValue()orderBy() * orderByDesc() * setDisplayValue() * setDynamicAttributeDisplayValue() * setDynamicAttributeValue() * setDynamicAttributeValues() * setValue() | | [GlideSysAttachment - Global](https://www.servicenow.com/docs/access?context=GlideSysAttachmentGlobalAPI&family=zurich&ft:locale=en-US) | Support for copying any attributes from source attachment records and deleting attributes with attachments. * copy() * copy(targetFieldName) * copyAttachmentsByFieldNames() * deleteAllAttachment() * deleteAttachment() | | [IdentificationEngineScriptableApi - Global](https://www.servicenow.com/docs/access?context=c_IdentEngineScriptAPI&family=zurich&ft:locale=en-US) | Enable the referenceItems properties of the incoming payload to be populated before identifying a CI using the IRE rules defined on a class. * createOrUpdateCI() * createOrUpdateCIEnhanced() * identifyCIEnhanced() | | [RESTMessageV2 - Scoped, Global](https://www.servicenow.com/docs/access?context=c_RESTMessageV2API&family=zurich&ft:locale=en-US) | setHttpMethod() - Added support for HEAD method calls via the method parameter. | [Table 21. Changed global classes in Zurich] |
[ ]

## Removed

Between your current release family and Zurich, some API features or functionality were removed.  
{#dfrn3-api-summary__entry__306}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## Deprecations

Between your current release family and Zurich, some API features or functionality were deprecated.  
{#dfrn3-api-summary__entry__314}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | * The GlideEncrypter API no longer supports Triple Data Encryption Standard (3DES) due to updated [NIST 800-131A Rev 2](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar2.pdf) guidelines. * For existing instances that upgrade to the Zurich release, the GlideEncrypter API is available for use but has been updated to automatically use the Key Management Framework algorithm. See [GlideEncrypter - Global (deprecated)](https://www.servicenow.com/docs/access?context=GlideEncrypterAPI&family=zurich&ft:locale=en-US) for more information on how to continue calling this API. * For all new instances created starting with the Zurich release, the GlideEncrypter API is no longer supported. Directly use the [Key Management Framework](https://www.servicenow.com/docs/access?context=encryption&family=zurich&ft:locale=en-US) instead for all cryptography operations. * Dynamic groups have been removed from dynamic schema in Core Platform. For dynamic attributes defined with an associated dynamic attribute group before the Zurich release, the [GlideDynamicAttribute](https://www.servicenow.com/docs/access?context=GlideDynamicAttributeAPI&family=zurich&ft:locale=en-US) getGroupName() method originally designed for dynamic attribute groups continues to work for backwards compatibility. The getGroupName() method returns null for migrated attributes and newly created attributes. Customers are urged to migrate to the current [Dynamic Attribute](https://www.servicenow.com/docs/access?context=working-with-dynamic-schema&family=zurich&ft:locale=en-US) definitions to take advantage of future improvements in features and functionality. For migration details, see the [Dynamic Schema Zurich Migration Guide \[KB2146133\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB2146133) article in the Now Support Knowledge Base. <!-- --> * For existing instances that upgrade to the Zurich release, the GlideEncrypter API is available for use but has been updated to automatically use the Key Management Framework algorithm. See [GlideEncrypter - Global (deprecated)](https://www.servicenow.com/docs/access?context=GlideEncrypterAPI&family=zurich&ft:locale=en-US) for more information on how to continue calling this API. * For all new instances created starting with the Zurich release, the GlideEncrypter API is no longer supported. Directly use the [Key Management Framework](https://www.servicenow.com/docs/access?context=encryption&family=zurich&ft:locale=en-US) instead for all cryptography operations. |
[ ]

## Activation information

Review information on how to activate API.  
{#dfrn3-api-summary__entry__322}

| Release | Release notes |
|-|-|
| 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 Service Exchange for Providers application (sn_sb_pro) and the Service Exchange 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. |
| Yokohama | Activation information :   The following APIs are available by default: * Attachment * Console * Fetch * Fetch.Headers * Fetch.Request * Fetch.Response * Fetch.RequestInit * GlideDynamicAttribute * GlideDynamicAttributeStore * GlideElementDynamicAttributeStore * GlideTransientDynamicAttribute * GlideUser * openFrameAPI * PDFGenerationAPI * RESTMessageV2 * ScriptableUriMatcher * SOAPMessageV2 * UriMatcher * UriMatcherResponse The following APIs require plugin activation: * The AI Asset API requires the Asset Classes (sn_ent) plugin to be activated. * The AP Invoice API requires the Accounts Payable Invoice Processing (com.sn_ap_apm) plugin to be activated. * The AWA Offer Work API requires the Advanced Work Assignment (com.glide.awa) plugin to be activated. * The IBQConfigBase API requires the Sales and Service API Core (com.sn_tmt_core) plugin to be activated. * The lead API requires the Lead Management Data Model (sn_lead_mgmt_core) plugin to be activated. * The Mobile SDK requires the Mobile SDK Android library (NowSDK) or the Mobile SDK iOS library to be downloaded and installed. * The openFrame API requires the com.sn_openframe_store plugin to be activated. * The OrderUtil API (script include) requires the Order Management (com.sn_ind_tmt_orm) plugin to be activated. * The ProcessMiningIntegrationAPI requires the Process Mining Core (com.sn_process_optimization) plugin to be activated. * The Product Order Open and the Product Inventory Open APIs require Order Management (sn_ind_tmt_orm) plugin to be activated. * The Sales Agreement API requires the following plugins to be activated: * Sales Agreement Data Model (com.sn_sales_agmt_core)  * Product Catalog Management Core (com.sn_prd_pm) * Pricing (com.sn_csm_pricing)   * 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 v_record API requires the Remote Tables (com.glide.script.vtable) plugin to be activated. * The Verify Entitlements API requires the Entitlement Verification (com.sn_ent_verify) plugin to be activated. |
| Zurich | Activation information :   The following APIs are available by default: * Identification and Reconciliation * IdentificationEngine * IdentificationEngineScriptableApi * GlideDynamicAttribute * GlideDynamicAttributeStore * GlideDynamicNamespace * GlideCurrencyCode * GlideCurrencySymbol * GlideForm (Next Experience) * GlideModal (Next Experience) * GlideNavigation (Next Experience) * GlideQueryCondition * GlideRecord * GlideSysAttachment * GlideUser(Next Experience) * StopWatch (Next Experience) The following APIs require plugin activation: * ProducerV2 requires the ServiceNow Stream Connect Installer plugin (com.glide.hub.stream_connect.installer). * Product Order Open API requires the Order Management for Telecommunications (sn_ind_tmt_orm) plugin. * Service Order Open API requires the Order Management for Telecommunications (sn_ind_tmt_orm) plugin. * The Omnichannel Callback API requires the Omnichannel Callback (omnichannel_callback plugin) plugin. * Party Management Open API requires the Telecommunications Open APIs (sn_tmf_api) and Customer Service Management (com.sn_customerservice) plugins. * The SegmentHandle, SegmentHandler, and sn_erp_integration API APIs require the Zero Copy Connector for ERP (com.sn_erp_integration) plugin. |
[ ]

## Additional requirements

If any additional requirements were introduced or changed for API we have noted them here.  
{#dfrn3-api-summary__entry__330}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## Browser requirements

If any specific browser requirements were introduced or changed for API we have noted them here.  
{#dfrn3-api-summary__entry__338}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## Accessibility information

Review details on accessibility information for API, such as specific requirements or compliance levels.  
{#dfrn3-api-summary__entry__346}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## Localization information

If there are specific localization considerations for API we have noted them here.  
{#dfrn3-api-summary__entry__354}

| Release | Release notes |
|-|-|
| Xanadu | No updates for this release. |
| Yokohama | No updates for this release. |
| Zurich | No updates for this release. |
[ ]

## Highlight information

If there are specific highlight considerations for API we have noted them here.  
{#dfrn3-api-summary__entry__362}

| Release | Release notes |
|-|-|
| 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](https://www.servicenow.com/docs/access?context=api-implementation-reference&family=xanadu&ft:locale=en-US) for more information. |
| Yokohama | * 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](https://www.servicenow.com/docs/access?context=api-implementation-reference&family=yokohama&ft:locale=en-US) for more information. |
| Zurich | * 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. * Client Next Experience APIs include client APIs compatible with the Next Experience UI. See [API implementation and reference](https://www.servicenow.com/docs/access?context=api-implementation-reference&family=zurich&ft:locale=en-US) for more information. |
[ ]