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

API highlights for the Yokohama 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 Yokohama release

Table 3. New REST APIs and additional endpoints to existing REST APIs in Yokohama
API Endpoints
AWA Offer Work API POST /now/awa/documents/{document_table}/{document_sys_id}/offer
Continuous Integration and Continuous Delivery (CICD) Update Set API
  • 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

Changed in this release

Table 7. Changed scoped classes in Yokohama
Class Methods
PDFGenerationAPI - Scoped, Global
  • 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 8. Changed global classes in Yokohama
Class Methods
PDFGenerationAPI - Scoped, Global
  • 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 9. Changed REST APIs in Yokohama
API Endpoints
Attachment API 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 10. Changed scoped classes in the ServiceNow Store
Application App Version Class Methods
Lead to Cash Core V1.4 LeadtoCashCore - Scoped Enhanced the performance of the Commit Instance API to improve number generation for the number field:
  • effect(): The _records_count return object is added to provide details about newly inserted records for a particular table, such as the table name and number of inserted records.
  • commitInstance(): A new additional parameter, useNumberGenerator, is added to optionally generate and apply sys_ids to new table records in bulk.
ATF Test Generator and Cloud Runner 2.7.2 TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email, Boolean separateUpdateSetPerScope, String scopeForGeneratingTests, String suiteName) Added the testSuite parameter allowing you to set the name of the new test suite that is created during test generation.
Table 12. Changed global classes in the ServiceNow Store
Application App Version Class Methods
ATF Test Generator and Cloud Runner 2.7.2 TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email, Boolean separateUpdateSetPerScope, String scopeForGeneratingTests, String suiteName) Added the testSuite parameter allowing you to set the name of the new test suite that is created during test generation.

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.