ServiceNow® APIs let you build custom applications and experiences. APIs were enhanced and updated in the Washington DC release.

API highlights for the Washington DC release

  • 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.

New in the Washington DC release

Table 1. New scoped classes and additional methods to existing scoped classes
ClassMethods
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 2. New global classes and additional methods to existing global classes
ClassMethods
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 3. 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

Changed in this release

Table 4. 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 5. 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 6. 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 7. 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 8. 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 9. 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 10. 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.

Activation information

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.