Combined API release notes for upgrades from Vancouver to Washington DC

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 Washington DC.

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 Washington DC

Before you upgrade to Washington DC, 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.

New features

Between your current release family and Washington DC, 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	generatePID() getPIDConfig() isProductInstance()
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	OnCallContactPrefTemplate() copyContactPreferences() deleteContactPreferenceAttempts()
OnCallEscalationTemplateSNC - Global	OnCallEscalationTemplateSNC() copyEscalationTemplatetoEscalationSet() deleteEscalationSetSteps()
ProcessMiningForExternalData - Scoped, Global	ProcessMiningForExternalData - scheduleCaseGeneration(String externalDataSysId)
ProductInstance API - Scoped, Global	generatePID() getPIDConfig() isProductInstance()
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

Changes

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

Release Release notes

Vancouver

Table 8. Changed scoped classes
Class	Methods
GlideAggregate - Scoped	The orderBy() method now accepts arguments that are glidefunctions.

Table 9. Changed global classes
Class	Methods
GlideAggregate - Global	The orderBy() method now accepts arguments that are glidefunctions.

Washington DC

Table 10. 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 11. 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 12. 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 13. 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 14. Changed scoped classes available in the ServiceNow Store
Application	Version	Class	Methods
Customer Service Management	2.0.0	LeadtoCashCore - Scoped	The LeadtoCashCore - getPrimitivesEPService(String sourceToTargetConfigID, Object context) method provides an new object parameter, context, which supports two options for displaying attribute values and for enabling the ability to invoke more than one instance at a time. The LeadtoCashCore - createInstance(String headerSysIDs, String lineSysIDs, Boolean isTarget, Object additionalParams) method supports the ability to create one or more entities using multiple header or line IDs in the API script. The LeadtoCashCore - delta(Object sourceJSON, Object dirtyJSON, Object additionalParams) method now supports multi-select use cases and retrieves action details in the source JSON. The LeadtoCashCore - effect(Object sourceJSON, Object targetJSON, Object additionalParams) method now supports the ability to invoke effect() with empty arrays of various related items to mark them as 'no change' between source and target JSONs.
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 15. 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 16. 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.

Removed

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


Release	Release notes
Vancouver	No updates for this release.
Washington DC	No updates for this release.

Deprecations

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


Release	Release notes
Vancouver	The cabrillo.attachments - addFile() method is deprecated. Use the cabrillo.attachments - addFiles() method instead. The GlideEncrypter - Global API and all associated methods are deprecated. Use platform alternatives instead detailed in the Knowledge Base article Alternative Encryption Products to GlideEncrypter.
Washington DC	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.

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.

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.

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.

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.

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.