Zurich API Reference

Release: zurich
ft:locale: English
ft:publication_title: Zurich API Reference
ft:clusterId: crapiref
bundleId: crapiref
workflow: Creator

API implementation and reference
API implementation
Scripting
Available script types
Glide class overview
Glide stack
Execution order
Script evaluation by data type
Scripting messages
Now Assist for Code
Explore Now Assist for Code
General guidelines
Configure
Install
Configure AI model providers
Enable or disable Now Assist skills
Use Now Assist for Code
Generate code
Code autocomplete
Code edit
Add comments
Explain and summarize code
Tracking AI-generated code
Now Assist for Code reference
Now Assist for Code properties
Now Assist for Code roles
Keyboard shortcuts
JavaScript syntax editor
Using the JavaScript syntax editor
Keyboard shortcuts
Script macros
Context menu options
Syntax errors and warnings
Create a script macro
HTML syntax editor
Code editor
Server-side scripting
Glide Server APIs
Classic Business rules
Script includes
Processors
API components
Security
Create: simple
Create: multi-table
Create: custom
Scripts - Background module
Sandbox environment
Guarded script evaluator
Review incompatible guarded scripts
Guarded script API support
Script sandbox evaluator
Installation settings
Calculating a due date
Querying tables
Running order guides automatically
Assigning execution plans
Using regular expressions
Using Java syntax in Javascript regex
Convert SNC regex to enhanced regex
Scriptable service catalog variables
Setting a GlideRecord variable to 'NULL'
Schedule Pages
XMLDocument script object
XMLHelper
JavaScript engine
Modes
Considerations for switching JavaScript modes
Set the JavaScript mode for an application
Turn on ECMAScript 2021 (ES12) mode for a script
Supported features
JavaScript API Context-sensitive help
Client-side scripting
Design and processing
Client scripts
UI scripts
Scripting catalog items
Mobile GlideForm scripting
AJAX
Useful scripts
Business rule use cases
Abort database actions
Restricting record access
Client-side script use cases
Field script use cases
Approval assignment scripts
Scheduling script use cases
Server-side script use cases
Validating date and time
Creating UI pages and macros
UI pages
UI macros
Jelly tags
Escaping types
Syntax extensions
Debugging scripts
Script Debugger
Access the Script Debugger
Script Debugger user interface
Script Tracer
Script Debugger status
Transaction details
Script Debugger controls
Evaluate expressions at runtime
Use breakpoints
Use logpoints
Multiple developer support
Impersonation support
Scripts - Background support
Domain separation
Debugging sessions
Debugging applications
Debugging business rules
Debugging classifications
JS Code Coverage Debug
JavaScript debug window
Access the JavaScript debug window
Watching fields
Writing to the debug log
Packages Call Removal Tool
Web services
Inbound
SOAP web service
Scripted Services
Creating
Customize response
Creating with static WSDLs
Create a service
Example
Create a static WSDL
Example
Create a static WSDL script include
Example
Using static WSDLs
Direct services
Modifying query responses with forms
Returning reference variable display values
Clearing instance values
Retrieving journal entries
Retrieving choice fields
Persisting an HTTP session
API functions
Data Retrieval
getKeys
getRecords
get
aggregate
Data modification
insert
insertMultiple
update
deleteRecord
deleteMultiple
Import sets
AttachmentCreator
Overriding endpoints
Enable HTTP compression
Preventing empty message elements
Insert related records
WSDL schema
Hierarchical messages
Specify signed request requirements
Activate Enhanced Web Service Provider - Common
Installed components
Configure secutiry
Set default security policy
Create a security policy
Create a WS-Security profile
Enforce strict security
Enable WS-Security verification
Make service accounts internal integration users
Debugging incoming envelopes
View a session log
Authentication examples
Example: WS-Security envelope header
WS-Security properties
WS-Security error messages
WS-Security reference
Long-running request properties
Record retrieval limitations
Strategies
Limiting results with filters
Using local data storage
Fetching and parsing data in code
JSONv2 web service
Object format
Response status
Setting the number of rows returned
Requiring incoming request authentication
Action parameters
Data Retrieval API
Data Modification API
RSS web service
Feed generator
Limiting results with a view
Formatting results
Basic authentication
Title override
Feed reader
Scrollable areas
Add scrolling form elements
Example
Example
Exporting records as complex data types
Examples
Java Apache Axis2
Insert
Update
Consume a ServiceNow Web Service
Microsoft .NET
Perl
Python
.NET tutorial
Configure .NET
Call a web service
Use a service reference in an integration
Use a web reference in an integration
Integration source code
Results
Troubleshoot a null response
ASP.NET with redirect and cookies
ASP.NET unencrypted SSO
Outbound
REST
Message elements
Create a message
Define an HTTP method
Test a method
Define an HTTP header
Sending messages through a MID Server
Using special characters in URIs
Outbound REST authentication
Configure a message with basic auth
Create a basic auth profile
Configure a message with OAuth
Use a third-party OAuth provider
Profiles and scopes
Specify a profile
Specify a scope
OAuth 2.0 profile tutorial: integrating with Google Contacts
Configure the Google service as OAuth provider
Create a provider and profile
Create a message
Mutual authentication
Message variable substitution
Generate variables
Scripting
Generate a message script
Direct RESTMessageV2 example
RESTMessageV2 MID server example
Recordless RESTMessageV2 example
SOAP
Video tutorial
Messages
Create
SOAP message functions
Variable substitution
Message testing
Sending messages through MID servers
Create with a WSDL and XSD file
Connectivity details
Security
Enable basic authentication
Enable WS-Security
Configure with a proxy
Scripting
Preview a message script
Direct SOAPMessageV2 example
Asynchronous SOAPMessageV2 example
SOAPMessageV2 MID server example
Recordless SOAPMessageV2 example
Logging
Configure
Exclusion domain requirements
Properties
Mutual authentication
Create a protocol profile
Enable
Additional integration resources
Using extension points
Using server-side scripted extension points
Creating and adding
Create
Add to base application code
Using server-side UI extension points
Creating and adding
Registering custom UI macros
Using client-side extension points
Creating and adding
Create
Add to base application code
Manage connection pooling
HTTP Connection Management Properties
Create data sources from other apps using ODBC driver
Getting started with ODBC
Create an ODBC user account and assign the odbc role
Define an ACL rule for the odbc role
Installing the ODBC driver
ODBC driver installation requirements and supported software
Download and install the ODBC driver
Upgrade the ODBC driver
Install an ODBC driver patch
Configuring the ODBC driver
Configure the ODBC driver
Configure the global DSN default
Create a new DSN
Specify a connection string
Configure the logging level of the ODBC driver
Configure the ODBC driver for large data sets
Configure ODBC to use proxy servers
Setting ODBC properties
Test the ODBC driver
Generate logs for debugging
Test a query
ODBC troubleshooting
ODBC behavior
Increase the field length in SQL queries
ODBC and client applications
Use Interactive SQL with ODBC
Specify the maximum number of rows returned
SQL support
ODBC driver in SQL Server
ODBC SQL Server video tutorials
Configure SQL Server
Use the ODBC driver in Excel
Use the ODBC driver in Crystal Reports
Domain separation and ODBC driver
Domain separation
Analyze REST and SOAP API usage
Collect analytics
View analytics
Analytics collection and cleanup
Analytics properties
Monitor inbound API integration usage
View dashboard
Registered integrations
Register Basic Authentication
Querying data using GraphQL
Create a schema
Enable introspective queries
Test with GraphQL Explorer
Query a schema from a component
System properties
Access your ServiceNow data using SQL API
Explore
SQL API architecture
Supported SQL functions
Common use cases
Configure
Install SQL API plugin on your ServiceNow instance
Configure SQL API plugin on your ServiceNow instance
Create a Service Account and assign Roles
Create Access Control Lists (ACLs) for SQL API
Create IP filter criteria
Download the SQL API drivers on client machine
Install ServiceNow SQL API ODBC driver on client machine
Configure ServiceNow SQL API ODBC driver on client machine
Test SQL API ODBC driver connection using Interactive SQL
Configure ServiceNow SQL API JDBC driver on client machine
Route SQL API calls to Read Replica
Integrate
Connect Power BI Desktop to ODBC driver
Connect DB Visualizer to JDBC driver
Reference
Minimum requirements and supported software for SQL API
Usage Limitations for SQL API
REST APIs
Use the REST API Explorer
Access
Create an incident record
Read the incident
Retrieve existing incidents
Update the incident
Delete the incident
Explore a table's REST API
Export to OpenAPI specification
Inbound REST API rate limiting
Create a rate limit
Reset a rate limit
Monitor rate limits
Investigate inbound violations
Debug in-bound REST queries
Return session debug logs
CORS domain requirements
Define a CORS rule
Enable OAuth with inbound REST
REST OAuth example
REST API HTTP response codes
Scripted REST APIs
Create
Create a scripted REST API resource
Define a response header
Define a request header
Associate a request header with a resource
Define a schema
Define an API resource request structure
Define an API resource response structure
Define available query parameters
Associate query parameters with a resource
Auto-generate API request definitions
Configure a scripted REST API to require an ACL
Configure a scripted REST API resource to require an ACL
Enable versioning for a scripted REST API
Add a version to a scripted REST API
Control request and response content type
Controlling maximum request size
Good practices
Examples
Script samples
Streaming vs object serialization
Streaming file attachments
API reference
Server API reference
AbstractDBObject - Global
AbstractReconciler - Global
AbstractScriptProcessor - Global
AbstractTimelineSchedulePage - Global
AccAgentsAPI - Scoped
AccCheckDefsAPI - Scoped
ActivityHistoryRecord - Global
action - Scoped, Global
Agent - Global
AgentMetrics - Global
AgentNowHandler - Scoped
APCHandler - Global
ApcPduOutletReconciler - Global
ArrayUtil - Global
AssessmentCreation - Global
AuthCredential - Scoped
AutomationException - Global
BusinessServiceManager - Global
CatalogJS - Scoped
CatalogSearch - Scoped
CatalogItemVariable - Scoped
CatalogClientScript - Scoped
CatalogItemVariableSet - Scoped
CatalogItemVariableSetM2M - Scoped
CatCategory - Scoped
CatItem - Scoped
CartJS - Scoped
CdmQuery - Scoped
Cell - Scoped, Global
CertificateEncryption - Scoped
ChangeCollisionHelper - Global
ChangeSuccess - Scoped
CheckDefinitionTestBuilder - Scoped
CheckInstanceTestBuilder - Scoped
CIActionEngine - Scoped
CIData - Global
CIIdentification - Global
CIIdentifierResult - Global
CimCIData - Global
CimIDSensor - Global
CimInstanceToken - Global
CimProbe - Global
CimProbeResult - Global
CIRelatedList - Global
CIUtils - Global
ClassificationSolutionStore - Global
ClassificationSolutionVersion - Global
ClassificationSolution - Global
ClassifierProbes - Global
Client - Scoped, Global
Cloud Runner TestGenerationApi – Scoped, Global
Cloud Runner TestRunnerApi – Scoped, Global
Cloud Runner TestUserApi – Scoped, Global
ClusteringSolution - Global
ClusteringSolutionStore - Global
ClusteringSolutionVersion - Global
CMDBDuplicateTaskUtils - Global
CMDBDuplicateTemplateUtil - Global
CMDBGroupAPI - Scoped
CMDBQBScopedScriptableAPI - Scoped
CMDBQueryBuilderAPI - Global
CMDBTransformUtil - Global
CMDBUtil - Global
Color - Scoped, Global
ConnectActionResponse - Global
ConnectionInfo - Scoped, Global
ConnectionInfoProvider - Scoped, Global
Console - Scoped, Global
Conversation - Scoped
CostPlanBatchOperations - Global
CriteriaEvaluator - Global
CSBScratchpadUtil - Scoped
CSVParser - Scoped
CTIOperationRequest - Scoped, Global
CTIOperationResponse - Scoped, Global
Data - Scoped, Global
DataBuilder - Scoped, Global
DCManager - Global
ScopedDCManager - Scoped
DatasetDefinition - Global
DateTimeUtils - Global
DecisionTableAPI - Scoped, Global
DevOpsOrchestrationToolIntegrationHandler - Scoped
DiscoveryAPI - Scoped
Document - Scoped, Global
DocumentListEntryService - Scoped, Global
DocumentListService - Scoped, Global
DocumentReferenceService - Scoped, Global
DocumentService - Scoped, Global
DocumentVersionService - Scoped, Global
DSCScriptableAPI - Global
DuplicateTemplate - Scoped
DurationCalculator - Global
DynamicSchemaAPI - Global
DynamicTranslation - Scoped
Encoder - Global
EncoderStore - Global
EncoderVersion - Global
Event - Global
EventProcessorUtilOOB - Scoped
EventQueueProcessorOOB - Scoped
ExpenseAllocation - Global
ExpenseLine - Global
ExtractTermsFromAttachment - Global
Fetch - Scoped, Global
Fetch Headers - Scoped, Global
Fetch Request - Scoped, Global
Fetch RequestInit - Scoped, Global
Fetch Response - Scoped,Global
FinancialsWidgetUtil - Scoped
Findings - Scoped, Global
FormInfoHeader - Global
FlowAPI - Scoped, Global
FlowScriptAPI - Scoped
Flow - Scoped (deprecated)
GenericUPSAlarmsReconciler - Global
GenericUPSBypassReconciler - Global
GenericUPSInputsReconciler - Global
GenericUPSOutputsReconciler - Global
GeniusResultAnswer - Scoped
GeniusResultContext - Scoped
GlideAggregate - Global
GlideAggregate - Scoped
GlideApplicationProperty - Scoped, Global
GlideappCalculationHelper - Global
GlideCalendarDateTime - Scoped (deprecated)
GlideCertificateEncryption - Global
GlideConversation - Global
GlideCurrencyCode - Scoped, Global
GlideCurrencyConfig - Scoped
GlideCurrencyConverter - Scoped
GlideCurrencyExchangeValue - Scoped
GlideCurrencyFormatter - Scoped
GlideCurrencyParser - Scoped
GlideCurrencySymbol - Scoped, Global
GlideCurrencyValue - Scoped
GlideDate - Global
GlideDate - Scoped
GlideDateTime - Global
GlideDateTime - Scoped
GlideDBFunctionBuilder - Scoped, Global
GlideDBFunctionCaseBuilder - Global
GlideDigest - Scoped
GlideDuration - Scoped
GlideDynamicAttribute - Global
GlideDynamicAttributeStore - Global
GlideDynamicNamespace - Global
GlideElement - Global
GlideElement - Scoped
GlideElementCurrency2 - Scoped
GlideElementDescriptor - Scoped, Global
GlideElementDynamicAttributeStore - Global
GlideEmailOutbound - Scoped
GlideEncrypter - Global (deprecated)
GlideEventManager - Global
GlideScopedEvaluator - Global
GlideScopedEvaluator - Scoped
GlideExcelParser - Scoped, Global
GlideFilter - Scoped, Global
GlideGeoPoint - Global
GlideHTTPRequest - Global
GlideHTTPResponse - Global
GlideImpersonate - Global
GlideImportLog - Scoped, Global
GlideImportSetRun - Scoped, Global
GlideImportSetTable - Scoped, Global
GlideImportSetTransformer - Scoped, Global
GlideImportSetTransformMap - Scoped, Global
GlideJsonPath - Global
GlideJWTAPI - Scoped
GlideListProperties - Global
GlideLocale - Scoped
GlideMultiRecurrence - Scoped
GlideOAuthClient - Scoped, Global
GlideOAuthClientRequest - Scoped, Global
GlideOAuthClientResponse - Scoped, Global
GlideOAuthToken - Scoped, Global
GlidePluginManager - Scoped
GlideQuery - Scoped, Global
GlideQueryCondition - Global
GlideQueryCondition - Scoped
GlideRecord - Global
GlideRecord - Scoped
GlideRecordUtil - Global
GlideSchedule - Scoped
GlideScriptableInputStream - Scoped, Global
GlideScriptedExtensionPoint - Scoped
GlideScriptedProcessor - Scoped
GlideSecureRandomUtil - Scoped, Global
GlideSecurityManager - Global
GlideSecurityUtils - Scoped, Global
GlideServletRequest - Scoped
GlideServletResponse - Scoped
GlideSession - Global
GlideSession - Scoped
GlideSPScriptable - Scoped
GlideSPSearchAnalytics - Global
GlideSPUtil - Global
GlideStringUtil - Scoped, Global
GlideSysAttachment - Global
GlideSysAttachment - Scoped
GlideSysListControl - Scoped
GlideSystem - Global
GlideSystem - Scoped
GlideSystemRunLevel - Global
GlideTableHierarchy - Scoped
GlideTextReader - Scoped
GlideTime - Scoped
GlideTimeline - Global
GlideTimelineItem - Global
GlideTransformLog - Scoped, Global
GlideUICompatibility - Scoped
GlideURI - Global
GlideURI - Scoped
GlideUser - Scoped
GlideUser - Global
GlideXMLUtil - Scoped, Global
GSLog - Scoped, Global
HermesEventPublisherOOB - Scoped
HistoryWalker - Scoped, Global
HostnameJS - Global
hr_ActivitySet - Scoped
hr_ActivityUtils - Scoped
hr_Utils - Scoped
HttpRequestAuthedData - Scoped
HttpRequestData - Scoped
IBQConfigBase API - Scoped
ICalUtilSNC - Global
IdentificationEngine - Scoped
IdentificationEngineScriptableApi - Global
IDResult - Global
IEventSender - Global
Image - Scoped, Global
Interaction - Scoped
IPAddress - Scoped, Global
IPAddressFixup - Global
IPService - Global
JavascriptProbe - Global
j2js - Global
JSON - Global
JSON - Scoped
JSONParser - Global (deprecated)
JSONStreamingAPI - Scoped
JSONStreamingBuilder - Scoped
JSUtil - Global
KMFCryptoOperation - Scoped, Global
LeadAPIHelperOOB - Scoped
LeadAPIProcessUtilOOB - Scoped
LeadAPIValidationUtilOOB - Scoped
LeadtoCashCore - Scoped
Line - Scoped, Global
LinterCheckAstNode - Scoped, Global
logger - Global
LSOFParser - Global
Message - Global
Messaging - Scoped
MetricInfo - Scoped, Global
MIDServer - Global
MIDServerAjax - Global
MIDServerCluster - Global
MIDServerFileSync - Global
MIDServerFinder - Global
MIDServerManage - Global
MIDServerSelector - Global
MLPredictor - Global (deprecated)
MLSolution - Global
MLSolutionFactory - Global
MLSolutionResult - Global (deprecated)
MLSolutionUtil - Global
MobileDeepLinkGenerator - Global
MonitorMIDServer - Global
NameValuePairs - Global
NetwareHandler - Global
Notify - Global
NotifyScoped - Scoped
NotifyAction - Global
NotifyConferenceUtil - Scoped, Global
NotifyJsTelephonyDriver - Global
NotifyNow (Legacy) - Global
NotifyPhoneNumber - Global
NotifyPhoneNumber - Scoped
NotifySMS - Global
NotifyUtil - Global
NumberFormatter - Scoped, Global
OAuthUtil - Global
OCRosterSpanApprovalUtil - Global
OCRotation - Global
OCRotationV2 - Global
OCRotaICalendarSNC - Global
OCRotaICalendar - Global
OCRotaMember - Global
OCSeriesEventGenerator - Global
OCTimer - Global
OnCallContactPreferenceUtil - Global
OnCallContactPrefTemplate - Global
OnCallEscalationTemplateSNC - Global
OnCallRotation - Global
OpenMessageBusEventPublisherOOB - Scoped
Optional - Scoped, Global
OrderGuide - Scoped
OrderUtil - Scoped
PADomainUtils - Global
Paragraph - Scoped, Global
PAScorecard - Scoped
PASnapshot - Scoped
PDAutomationProvider - Scoped, Global
PDFGenerationAPI - Scoped, Global
PdfMergeSignRequestor - Scoped, Global
PdfPage - Scoped, Global
PersonalAuthAPI - Scoped
PlaybookExperience - Scoped
PolarisUI - Scoped
PredictabilityEstimate - Global
PredictabilityEstimateStore - Global
PredictabilityEstimateVersion - Global
PreferenceDestination - Scoped, Global
Preferences - Scoped, Global
ProactiveTriggerAPI - Scoped
ProbeHandlerCim - Global
ProbeHandlerMulti - Global
ProbeHandlerSNMP - Global
ProbeHandlerWMI - Global
ProcessMiningForExternalData - Scoped, Global
ProcessMiningIntegrationAPI - Scoped
Producer - Scoped (deprecated)
ProducerV2 - Scoped
ProductInstance - Scoped, Global
PSBScratchpadUtil - Scoped
Queue - Global
Queue - Scoped
QuickRanges - Global
RecordToHTML - Global
RegressionSolution - Global
RegressionSolutionStore - Global
RegressionSolutionVersion - Global
RemedialActionEngine - Scoped
RemoteTableCacheManager - Scoped
RenderProperties - Global
RenderProperties - Scoped
ReportCiStatusOutputJS - Scoped
RequestAuthAPI - Scoped
ResponseTemplate - Scoped, Global
RESTAPIRequest - Scoped, Global
RESTAPIRequestBody - Scoped, Global
RESTAPIResponse - Scoped, Global
RESTAPIResponseStream - Scoped, Global
RESTMessageV2 - Scoped, Global
RESTResponseV2 - Scoped, Global
RoundingInterval - Global
RTETransformer - Scoped
sb - Scoped, Global
SCIM2Client - Scoped
SCIM2ClientUtil - Scoped
ScopedCacheManager - Scoped
ScriptableDataStream - Scoped, Global
ScriptableFlowRunner - Scoped
ScriptableFlowRunnerResult - Scoped
ScriptableUriMatcher - Scoped, Global
SegmentHandle API - Scoped
SegmentHandler API - Scoped
SentimentAnalyser - Scoped
SerialNumberManager - Global
ServiceRegistryQuery - Global
ShazzamLaunch - Global
ShazzamResult - Global
ShazzamScanner - Global
SimilaritySolution - Global
SimilaritySolutionStore - Global
SimilaritySolutionVersion - Global
SkillDeterminationUtils - Scoped
SLARepair - Global
SLPServiceRegistryQuery - Global
SMSPreferenceHandlerSNC - Scoped, Global
sn_erp_integration API - Scoped, Global
SNEventSenderProvider - Global
SNMPGatherDocParts - Global
SNMPNetworkInterfaces - Global
SNMPResponse - Global
SOAPMessageV2 - Scoped, Global
SOAPResponseV2 - Scoped, Global
SPScriptedFacet - Scoped
SPScriptedFacetService - Scoped
SPSEOUtilsSNC - Global
SPWidgetAccessControl - Global
StandardCredentialsProvider - Scoped, Global
StartDiscovery - Global
StateManagementScriptableApi - Global
Style - Scoped, Global
Stream - Scoped, Global
Subflow - Scoped (deprecated)
SummaryTableWriter - Global
SVGToPDFConversionAPI - Scoped, Global
SystemDocument - Scoped, Global
SystemDocumentList - Scoped, Global
SystemDocumentListEntry - Scoped, Global
SystemDocumentVersion - Scoped, Global
Table - Scoped, Global
TableUtils - Global
TaskStateUtil - Global
TemplatePrinter - Scoped
TimelineSpan - Global
TMFTopicEventAPIUtilOOB - Scoped
TopicAPIUtilsOOB - Scoped
TopicSubscriptionUtilOOB - Scoped
TopicUtilOOB - Scoped
Transformer - Scoped, Global
Transformer - Scoped, Global
TransformerDefinition - Scoped, Global
TransformerRuleList - Scoped, Global
TransformPart - Scoped, Global
TransformResult - Scoped, Global
TroubleTicketNotificationUtilOOB - Scoped
UniversalRequestUtilsSNC - Scoped
UniversalTaskUtils - Scoped, Global
UPSHandler - Global
UriMatcher - Scoped
UriMatcherResponse - Scoped
UserCriteria - Scoped
UserSkillAnalyzer - Global
UserSkillRanking - Global
v_query – Scoped, Global
v_record - Scoped, Global
v_table – Scoped, Global
VMUtils - Global
VoiceTranscriptObject - Scoped
WalkWorkflow - Global
WFActivityHandler - Global
WindowsOSNameHelper - Global
Workflow - Global
Workflow - Scoped
WorkflowDuration - Global
WorkflowModelManager - Global
WorkflowModelManagerAjax - Global
WorkflowScheduler - Global
WorkflowTimeline - Global
XMLDocument2 - Scoped, Global
XMLNode - Scoped, Global
XMLNodeIterator - Scoped
XMLStreamingAPI - Scoped
XMLStreamingBuilder - Scoped
XMLUtilJS - Global
Client API reference
StandaloneClientMethods
DynamicTranslation - Client
g_service_catalog - Client
GlideAgentWorkspace (g_aw) - Client
GlideAjax - Client
GlideDialogWindow - Client (deprecated)
GlideDocument - Client
GlideFlow - Client
GlideForm (g_form) - Client
Mobile GlideForm (g_form) - Client
GlideGuid - Client
GlideList2 (g_list) - Client
GlideListV3 (g_list) - Client (deprecated)
GlideMenu (g_menu and g_item) - Client
GlideModalForm - Client
GlideModal - Client
GlideNavigation - Client
GlideNotification - Client
GlideRecord - Client
GlideURLV3 - Client
GlideUser - Client
GlideUIScripts - Client
Guided Tours - Client
i18N - Client
openFrameAPI - Client
NotifyClient - Client
NotifyOnTaskClient - Client
ScopedSessionDomain - Client
ScriptLoader - Client
SNAnalytics - Client
spAriaUtil - Client
spContextManager - Client
spModal - Client
spUtil - Client
StopWatch - Client
Client Next Experience API reference
g_modal (Next Experience) - Client
GlideForm (Next Experience) - Client
GlideList (Next Experience) - Client
GlideModal (Next Experience) - Client
GlideNavigation (Next Experience) - Client
GlideUser (Next Experience) - Client
StopWatch (Next Experience) - Client
UIB API reference
api - UI Builder
helpers - UI Builder
Client mobile API reference
Cabrillo JS constants
Cabrillo JS data types
cabrillo - Client
cabrillo.attachments - Client
cabrillo.camera - Client
cabrillo.flowControl - Client
cabrillo.message - Client
cabrillo.modal - Client
cabrillo.navigation - Client
cabrillo.nowapp - Client
cabrillo.viewLayout - Client
m_form - Client
MobileScriptIncludeCaller - Client
Mobile SDK API reference
Mobile SDK - Android
AuthorizationToken class - Android
Call interface - Android
FetchConfiguration class - Android
FieldReadConfiguration class - Android
FieldWriteOptions structure - Android
Filter class - Android
NotSupportedPushError class - Android
NowAnalyticsSDK interface - Android
NowAPIService interface - Android
NowAttachment class - Android
NowAttachmentMetadata class - Android
NowAttachmentService interface - Android
NowChatConfiguration class - Android
NowChatSDK class - Android
NowChatSdkCallbacks interface - Android
NowChatService class - Android
NowChatTheme interface - Android
NowDataSDK class - Android
NowGraphQLService interface - Android
NowPushPayload interface - Android
NowPushSDK class - Android
NowPushService class - Android
NowSDK - Android
NowSDKAuthorizationProviding interface - Android
NowSDKConfiguration class - Android
NowServiceConfiguration class - Android
NowServiceError class - Android
NowTableService interface - Android
NowWebTheme interface - Android
NowWebSDK class - Android
NowWebService class - Android
NowWebViewServiceDelegate interface - Android
Paginator class - Android
Mobile SDK - iOS
FetchConfiguration structure - iOS
FieldReadConfiguration structure - iOS
FieldWriteOptions class - iOS
Filter structure - iOS
NowAnalyticsService protocol - iOS
NowAnalyticsServiceDelegate protocol - iOS
NowAPIEndpoint protocol - iOS
NowAPIService class - iOS
NowAttachment structure - iOS
NowAttachmentMetadata structure - iOS
NowAttachmentService class - iOS
NowAttachmentUploadConfiguration structure - iOS
NowChat API - iOS
NowChatColoring protocol - iOS
NowChatConfiguration - iOS
NowChatService class - iOS
NowChatServiceDelegate protocol - iOS
NowChatThemeable protocol - iOS
NowCoreService class - iOS
NowData framework - iOS
NowGraphQLService class - iOS
NowLoggingService class - iOS
NowPush API - iOS
NowPushPayload protocol
NowPushService class - iOS
NowRecord class - iOS
NowSDK framework - iOS
NowSDKConfiguration class - iOS
NowService protocol - iOS
NowServiceConfiguration structure - iOS
NowTableService class - iOS
NowWeb API - iOS
NowWebColoring protocol - iOS
NowWebService class - iOS
NowWebThemeable protocol - iOS
NowWebViewController class - iOS
NowWebViewControllerDelegate protocol - iOS
Paginator API - iOS
SNMobileAnalytics API
REST API reference
Account API
ActivitySubscriptions API
Agent Client Collector API
Agent Mapping API
Aggregate API
AI Assets API
AI Search External User Mapping API
Alarm Management Open API
AP Invoice API
Application Service API
Appointment API
Appointment Open API
Attachment API
Automation Center API
AWA Agent API
AWA Agent Consult API
AWA Inbox Actions API
AWA Manual Assignment API
AWA Offer Work API
AWA Routing API
Batch API
Case API
CCCIF Media Resource API
CdmApplicationsApi
CdmChangesetsApi
CdmEditorApi
CdmPoliciesApi
CdmSharedLibraryApi
CdmSnapshotApi
CdmVersionApi
Change Management API
CI Lifecycle Management API
Cloud Runner Test Generation REST API
Cloud Runner Test Runner REST API
Cloud Runner Test User REST API
Cloud Services Catalog API
CMDB Data Ingestion API
CMDB Instance API
CMDB Meta API
Consumer API
Contact API
Continuous Integration/Continuous Delivery (CICD) API
Continuous Integration and Continuous Delivery (CICD) Update Set API
Conversation Member API
CSM Attachment API
CSM Pricing API
CTI API
Customer Central API
Data Classification API
DCIM Metric Data Feed API
DevOps API
DevOps Config API
Digital Product Release API
Email API
Entitlement API
Event Management Topic Open API
Event Notification Management Open API
External Content Ingestion API
External ID Mapping API
HR REST API
Identification and Reconciliation API
Import Set API
Install Base Item API
Knowledge Management REST API
lead API
MetricBase Time Series API
Omnichannel Callback API
openframe API
Order API
Party Management Open API
Predictive Intelligence API
Proactive Engagement API
Product Catalog Open API
Product Inventory Open API
Product Order Open API
Project Portfolio Management API
Push Installation API
Push Metrics API
Quote Management API
Remote help request API
Resource Inventory Open API
Response Templates API
Sales Agreement API
SAM-Software Usage Data Integration API
Scorecards API
Script Debugger API
Service Catalog API
Service Catalog Open API
Service Contract API
Service Order Open API
Service Test Management Open API
SG Services API
SpendInt APIs
System for Cross-domain Identity Management (SCIM) API
Table API
Technical Service Qualification Open API
TISC API
TISC Intel Exchange API
TISC RPZ API
TISC TAXII Server API
Trouble Ticket Open API
User Role Inheritance API
Verify Entitlements API
Virtual Agent Bot Integration API
Voice Interaction Resource API
Work Order Management API
Workplace Connector Webhook API
Wrap Up API
WSD Extra Service API
WSD Extra Service Request API
WSD Group Reservation API
WSD Multi Reservation API
WSD Recurring Reservation API
WSD Reservable API
WSD Reservable V2 API
WSD Reservable Module API
WSD Reservation API
WSD Reservation Invitees API
WSD Search API
WSD Shift API
ServiceNow Fluent
Browse APIs by product
Developer guides
Alarm Management Open API Developer Guide
AP Invoice API Developer Guide
Event Notification Management Open API Developer Guide
GlideGeoPoint Developer Guide
Mobile SDK Developer Guide - Android
NowSDK architecture
Get started with Mobile SDK - Android
Download and install the Mobile SDK library
Install and configure the Mobile SDK scoped application
Configure your project
Configure certificate and create an OAuth Entity
Configure guest user access
Initialize the NowSDK in your application
Implement Virtual and Live Agent chat
Pass NowChatConfiguration to modify the behavior of NowChat
Interact with table data in a ServiceNow instance
Configure return results data
Configure field write options
Paginate return results record sets
Configure tables to work with guests
Interact with the public REST API on a ServiceNow instance
Retrieve attachments and attachment metadata
Display web pages hosted on your ServiceNow instance
Configure push notifications
Setting up push notifications on your ServiceNow instance
Retrieve the Firebase push server key
Add a push application record
Add a default push registration
Add a push notification message content record
Add a push notification message
Modify the push notification
Setting up push notifications in your Android application
Use NowUIColoring to theme NowWebTheme and NowChatTheme
Mobile SDK Developer Guide - iOS
NowSDK architecture
Get started with Mobile SDK - iOS
Download and install the Mobile SDK libraries
Install and configure the Mobile SDK scoped application
Configure your project
Configure certificate and create an OAuth Entity
Configure guest user access
Initialize the NowSDK in your application
Implement Virtual and Live Agent chat
Passing context variables to Live Agent and Virtual Agent chat
Interact with table data in a ServiceNow instance
Configure return results data
Configure field write options
Paginate return results record sets
Transform data
Interact with the public REST API on a ServiceNow instance
Retrieve attachments and attachment metadata
Display web pages hosted on your ServiceNow instance
Configure push notifications
Setting up push notifications on your ServiceNow instance
Generate and retrieve an iOS push certificate
Add a push certificate record
Add a push application record
Add a default push registration
Add a push notification message content record
Add a push notification message
Modify the push notification
Setting up push notifications in your iOS application
Work with coders and Codable models
Archive your application for publishing
Use NowUIColoring when theming NowWebThemeable and NowChatThemeable
Producer Event Notification Framework developer guide
Create outbound Order Management notifications using the open message bus
Add a business rule for a new Order Management event
Configure the Producer Event Notification Framework to use the Hermes Messaging Service
Configure the Producer Event Notification Framework to use the Open Message Bus
Configure trouble ticket notifications using the Producer Event Notification Framework
Add a business rule for a new trouble ticket event
Generate the payload for a new trouble ticket event
Modify a trouble ticket event payload
Override Event Management Topic Open API functionality
Product Order Open API Developer Guide
Resource Inventory Open API Developer Guide
ScopedCacheManager API Developer Guide
Service Order Open API Developer Guide
Trouble Ticket Open API Developer Guide
Client GlideList API in the Workspace Experience UI Developer Guide

Back to home page