Server Api Reference

The AccAgentsAPI script include enables you to perform management actions on available agents.

The AccCheckDefsAPI script include enables managing check definitions and associated parameters.

The action API provides methods to handle data for URLs in a UI action script.

The AgentNowHandler script include provides methods that enable running check definitions on demand, checking the status of on demand executions and test check executions and for stopping background checks that were executed on demand.

Use server APIs in scripts to change the functionality of applications, or when you create new applications.

The AuthCredential() API provides methods that enable you to build credentials for a REST request.

The BusinessServiceManager API provides methods that unify service management by converting manually-created services to application services, populating application services, and adding/removing configuration items and connections.

The AbstractDBObject script include provides common methods for classes based on records in the database.

The AbstractReconciler script include provides methods to use as a base class to create your own Discovery reconciler.

The AbstractScriptProcessor script include is a base JavaScript processor class that other JavaScript processors extend.

The AbstractTimelineSchedulePage script include is a helper class to facilitate working with the data displayed on timelines.

The ActivityHistoryRecord API provides methods that facilitate interacting with a WorkflowModelManager object. It is a data object that is a member of the WorkflowModelManager class.

The Agent API provides methods for getting or setting agent presence and channel availability.

The AgentMetrics script include provides methods to process inbound MID Server metrics.

The APCHandler script include provides methods to handle SNMP classification and identification for uninterruptible power supplies, environmental monitors, and power distribution units made by APC.

The ApcPduOutletReconciler API provides methods to reconcile outlets for power distribution units.

The ArrayUtil script include provides methods for working with JavaScript arrays.

The AssessmentCreation API provides methods that administrators can use to generate assessments and surveys.

The AutomationException script include provides generic exception wrapping for automation.

The CartJS API provides methods that enable you to access a user's shopping cart.

The CatalogClientScript API provides methods that enable you to create, modify, or delete catalog client script records.

The CatalogItemVariable API provides methods that enable you to create and modify service catalog item variables using scripts.

The CatalogItemVariableSet API provides methods that enable you to create and modify service catalog item variable sets using scripts.

The CatalogItemVariableSetM2M API provides methods that enable you to create and modify service catalog item variable set many-to-many (M2Ms) using scripts.

The CatalogSearch API provides methods that enable you to search catalog items.

The CatCategory API provides methods that enable you to create and modify service catalog categories using scripts.

The CatItem API provides methods that enable you to create and modify service catalog items using scripts.

The CertificateEncryption API provides methods for encrypting certificates in scoped applications.

The ChangeCollisionHelper script include provides helper methods found in the Change Management - Collision Detector (com.snc.change.collision) plugin.

The CIData script include is a utility class that provides methods for working with configuration item (CI) data structures in JavaScript.

The CIIdentification script include provides methods for discovery of configuration item (CI) identification.

The CIIdentifierResult script include provides methods that return the result returned by a configuration item identifier.

The CimCIData script include provides a wrapper for Common Information Model (CIM) configuration item (CI) data manipulation.

The CimIDSensor script include provides methods to perform identification for Common Information Model (CIM) probe results.

The CimInstanceToken script include provides methods to represent the unique query identity of a Common Information Model (CIM) instance.

The CimProbe script include provides methods to maintain Common Information Model (CIM) probe metadata.

The CimProbeResult script include provides methods to process Common Information Model (CIM) probe results.

The CIRelatedList script include is a utility class that provides methods for working with configuration item (CI) related lists.

The CIUtils script include is a utility class that provides methods for working with configuration items (CI).

The ClassifierProbes script include provides a classifier probe launch facility. Encapsulates an array of probe information records, initialized either from a JavaScript array or the XML serialized version.

The CMDBGroupAPI provides methods for performing actions on Configuration Management Database (CMDB) groups.

The CMDBTransformUtil script include uses the Identification and Reconciliation (IRE) framework to minimize the creation of duplicate configuration items (CI).

The CMDBUtil API provides utility methods for creating and managing table relationships in the Configuration Management Database (CMDB) and managing CMDB baselines.

The ConnectActionResponse API provides a method to create a glide record.

The Conversation API enables you to create or modify Connect conversations.

The CriteriaEvaluator script include provides methods to implement a general-purpose criteria evaluator.

The DateTimeUtils script include is a collection of date/time functions.

The DiscoveryAPI class provides methods that launch a quick discovery of a single IPv4 address and return summaries of previously launched discovery statuses for a single configuration item (CI) or for all scanned CIs.

The DurationCalculator script include provides methods for calculating durations and due dates.

The ExpenseAllocation script include is used by various cost management processes and can also be used for generating custom expense allocation records (fm_expense_allocation) from scripted expense allocation rules.

The ExpenseLine script include is used by various cost management processes and can also be used for generating expense line (fm_expense_line) records from your own server-side scripts.

The ExtractTermsFromAttachment script include provides methods to extract terms from an attachment.

The FormInfoHeader script include provides methods to add an HTML message as a form info message.

The GenericUPSAlarmsReconciler script include provides methods to obtain reconciler information for generic uninterruptible power supply (UPS) alarms.

The GenericUPSBypassReconciler script include provides methods to obtain reconciler information for generic uninterruptible power supply (UPS) bypasses.

The GenericUPSInputsReconciler script include provides methods to obtain reconciler information for generic uninterruptible power supply (UPS) inputs.

The GenericUPSOutputsReconciler script include provides methods to obtain reconciler information for generic uninterruptible power supply (UPS) outputs.

The GlideAggregate API enables creating database aggregation queries.

The GlideAggregate API enables creating database aggregation queries.

The GlideCertificateEncryption API provides methods for encrypting certificates.

The GlideConversation API provides methods to access information in a Connect message.

The scoped GlideDate class provides methods for performing operations on GlideDate objects, such as instantiating GlideDate objects or working with GlideDate fields.

The GlideDateTime class provides methods for performing operations on GlideDateTime objects.

The scoped GlideDateTime class provides methods for performing operations on GlideDateTime objects.

The scoped GlideDigest class provides methods for creating a message digest from strings or input streams using MD5, SHA1, or SHA256 hash algorithms.

The GlideDuration class provides methods for working with spans of time known as durations.

The GlideElement API provides a number of convenient script methods for dealing with fields and their values. GlideElement methods are available for the fields of the current glide record.

The GlideElementDescriptor API provides information about individual fields in a glide record.

The scoped GlideElement API provides a number of convenient script methods for dealing with fields and their values. Scoped GlideElement methods are available for the fields of the current glide record.

The scoped GlideEmailOutbound API implements the email object for scoped applications. You can use the GlideEmailOutbound methods with the email global object available in mail scripts. The email object behaves identically for global and scoped applications.

The GlideScopedEvaluator API allows you to evaluate scripts in a GlideRecord field from both scoped and global server scripts.

The GlideFilter API enables filtering queries to determine if one or more records meet a specified set of requirements.

The GlideLocale API provides information about display information for the local instance.

The GlideOAuthClient API provides methods for requesting and revoking OAuth refresh and access tokens.

The GlideOAuthClientRequest API provides methods for handling OAuth client requests.

The GlideOAuthClientResponse API provides methods for handling OAuth client responses.

The GlideOAuthToken API provides methods for retrieving OAuth access token and information about the access token.

The scoped GlidePluginManager API provides a method for determining if a plugin has been activated.

This API provides AND or OR conditions that can be added to the current condition, allowing you to build complex queries.

This API provides AND or OR conditions that can be added to the current condition, allowing you to build complex queries.

The GlideRecord API is used for database operations.

The scoped GlideRecord API is used for database operations.

The GlideRecordUtil script include is a utility class for working with GlideRecords.

The scoped GlideSchedule API provides methods for performing operations on GlideSchedule objects, such as adding new schedule segments to a schedule, determining if a date/time is within the schedule, or setting the schedule timezone.

A GlideScriptableInputStream object cannot be instantiated directly, but is used as an opaque object which is used to connect an input stream from GlideSysAttachment.getContentStream() with other streaming APIs.

The GlideScriptedProcessor API provides a customizable URL endpoint that can execute arbitrary server-side JavaScript code and produce output such as TEXT, JSON, or HTML. ServiceNow processors are equivalent to Java servlets.

The GlideSecureRandomUtil API provides methods for generating integers, long values, and strings.

The GlideServletRequest API provides methods to use in processor scripts.

The GlideServletResponse API provides methods to use in processor scripts.

The GlideSession API provides methods to find information about the current session.

The scoped GlideSession API provides methods to find information about the current session.

The GlideSPScriptable API provides methods to interact with data and perform record operations in Service Portal widgets.

The GlideSysAttachment API provides methods to handle attachments.

The GlideSysListControl API provides methods that enable you to determine if the New or Edit buttons are displayed.

The GlideSystem API, which is referred to by the variable name gs in any server-side JavaScript, provides a number of convenient methods to get information about the system, the current logged in user, and date/time information.

The scoped GlideSystem API provides a number of convenient methods to obtain information about the system, the current logged in user, and other system level information.

The GlideTableHierarchy API provides methods for handling information about table relationships.

The GlideTextReader API provides the ability to read single lines from an input stream. Because an input stream is used, it is not subject to the 5MB attachment size limit.

The GlideTimeline API provides the core implementation for configuring and displaying a Glide Windowing Toolkit Timeline.

The GlideTimelineItem API extends the abstract ScheduleItem class to define additional properties that are specific to the time line.

The GlideTime API provides methods for performing operations on GlideTime objects, such as instantiating GlideTime objects or working with GlideTime fields.

The GlideUICompatibility API provides the ability for scoped applications to define their own minimum browser versions. This is done by creating system properties for the scoped application.

The GlideURI API provides methods to handle URI parameters in a scoped application.

The GlideUser API provides methods to access information about the current user and current user roles.

The HostnameJS script include provides methods to format host names according to property settings.

The ICalUtilSNC script include provides functions to generate iCalendar compliant events.

The IdentificationEngineScriptableApi uses the Identification and Reconciliation framework to minimize the creation of duplicate configuration items (CIs) and to reconcile CI attributes by only accepting information from authorized data sources when updating the Configuration Management Database (CMDB).

The IDResult script include is a container class for the result of a CI Identifier.

The IPAddressFixup script include provides methods that ensure that no other device has the same IP address, after a device has been successfully discovered. If any duplicates are found, the IP address field is cleared.

The IPService script include provides methods that encapsulate an IP Service.

The j2js script include enables you to convert Java objects to JavaScript objects.

The JavascriptProbe script include provides methods for using the JavascriptProbe on the MID Server.

The JSON script include provides methods to create JSON objects from a string, and to turn JSON objects into strings.

The JSONParser API provides a JSON parser that does not use the JavaScript eval() function.

The JSUtil script include provides shortcuts for common JavaScript routines.

The logger API provides inbound email actions that append messages to the email log.

The LSOFParser script include provides methods to parse the output of the lsof command: lsof -i4TCP -n -P -F pcnfT.

The MIDServerAjax script include provides AJAX functionality for sending a test probe to a MID Server

The MIDServer script include provides methods to encapsulate the notion of a MID Server.

The MIDServerCluster script include provides methods to find MID Server clusters for a given MID Server and reassigns the jobs if necessary.

The MIDServerFileSync script include provides methods to check to see if there are any changes to attachments on tables that are instances of MID Server synchronized files (ecc_agent_sync_file) and, if so, notifies the MID Servers of a change.

The MIDServerFinder script include provides methods to find a list of MID Servers for specified IP addresses.

The MIDServerManage script include provides methods that allow you to manage a MID Server by sending messages to start, stop, upgrade, get logs, send test probes, and send system messages.

The MIDServerSelector script include provides methods to find a MID Server based on capabilities and target IP address.

The MLPredictor API provides utility methods for Predictive Intelligence predictions.

The MonitorMIDServer script include provides methods to monitor MID Servers using the heartbeat probe to check for MID Servers that are down, sends heartbeat requests, and kills old heartbeat requests.

The NameValuePairs script include provides methods to convert between maps and strings representing the name/value pairs in the map.

The NetwareHandler script include implements an SNMP handler for Netware OS.

The NotifyAction API allows you to define actions to send to a telephony provider.

The Notify API allows you to interact with Notify calls and SMS messages using scripts.

The legacy NotifyNow API provides functionality for sending emails, sending SMS messages, and setting up conference calls.

The NotifyPhoneNumber API allows you to query information about a Notify phone number.

The OAuthUtil script include modifies request parameters and parses the token response during runtime.

The OCRosterSpanApprovalUtil script include provides methods for the PTO approval feature.

The OCRotaICalendar script include is an extension of the OCRotaICalendarSNC script include.

The OCRotaICalendarSNC script include provides iCal formatted events for the a specific user's rotation.

The OCRotaMember script include provide methods to perform maintenance operations on the On-call Member [cmn_rota_member] table.

The OCRotation script include provides methods to build a data structure that is used to display a calendar.

The OCRotationV2 script include is an extension of OCRotation script include, which is used by Fullcalendar.io and the DHTMLX On-Call Calendar.

The OCSeriesEventGenerator script include provide methods to generate the repeating VEVENTS for a user's iCalendar.

The OCTimer script include provides methods to track the length of time it takes for a function to complete.

The OnCallContactPreferenceUtil script include provides methods for handling contact preferences.

The OnCallRotation script include provides methods to manage on-call schedules.

The PADomainUtils API enables you to copy Performance Analytics records between different domains on the same instance.

The ProbeHandlerCim script include provides methods to configures a Common Information Model (CIM) probe.

The ProbeHandlerMulti script include is a probe handler for multiprobes.

The ProbeHandlerSNMP script include is a discovery probe handler for SNMP probes, invoked when an SNMP probe is about to be created.

The ProbeHandlerWMI script include is the discovery probe handler for Windows Management Instrumentation (WMI) probes.

The Queue API (Advanced Work Assignment) provides methods to route a document to a queue.

The QuickRanges script include provides methods to generate IP network, range, and address entries from a convenient comma-separated input field using conventional Classless Inter-Domain Range (CIDR) network notation, hyphenated range entries, or individual IP addresses.

The RecordToHTML script include is a utility class to turn a record into HTML.

The ReportCiStatusOutputJS API provides methods that return specific object properties for the DiscoveryAPI reportCiIpAddressStatus method and then converts the information into a JSON string.

The RESTMessageV2 API provides methods that allow you to send outbound REST messages using JavaScript.

The RESTResponseV2 API provides methods that allow you to use the data returned by an outbound REST message in JavaScript code.

The RoundingInterval script include provides methods that handle all the details of rounding intervals for CPU speed and RAM size.

The RESTAPIRequest API provides methods that allow you to access scripted REST API request details in scripts.

The RESTAPIRequestBody API provides methods that allow you to access the body content of a scripted REST API request in scripts.

The RESTAPIResponse API provides methods that allow you to build a RESTful response to a scripted REST API request.

The RESTAPIResponseStream API provides methods that allow you to write directly to the scripted REST API response stream.

The SerialNumberManager script include provides methods to manage the serial numbers for discovery devices.

The ServiceRegistryQuery script include provides methods to map Shazzam service registry query results against a port probe. Child classes provide specifics on mapping.

The ShazzamLaunch script include provides methods to handle the details of launching a Shazzam probe for a given discovery.

The ShazzamResult script include provides methods to encapsulate a Shazzam result.

The ShazzamScanner script include provides methods to encapsulate a Shazzam scanner.

The SLARepair script include provides methods that delete the existing SLAs and then recreates them from each task's history.

The SLPServiceRegistryQuery script include provides methods to map Shazzam! SLP query results to port probes.

The SNMPGatherDocParts script include provides methods to handle the gathering of parts of an SNMP response document for JavaScript SNMP sensors.

The SNMPNetworkInterfaces script include provides methods to create network interfaces for JavaScript SNMP sensors.

The SNMPResponse script include provides methods to wrap an SNMP payload response instance with methods to safely and easily retrieve SNMP singleton fields or tables.

The SOAPMessageV2 API provides methods to send an outbound SOAP message using JavaScript.

The SOAPResponseV2 API provides methods that use the data returned by an outbound SOAP message in JavaScript code.

The StartDiscovery script include provides methods to start discovery jobs.

The SummaryTableWriter script include enables the creation of summary sets for reports that can be generated with standard queries and trending.

The TableUtils script include provides shortcuts for accessing table related information.

The TaskStateUtil script include provides methods for working with task-type table state attributes.

The TemplatePrinter API provides methods to handle printing from a mail script to the email message.

The TimelineSpan API provides methods to define a set of properties that describe the characteristics and interactive behavior of an element rendered within a time line item.

The UPSHandler script include provides methods to handle SNMP classification and identification for uninterruptible power supplies (UPSs).

The UserCriteria API provides methods to create, modify, and delete user criteria records using scripts.

The VMUtils script include provides methods for discovery and provisioning of virtual machines.

The WalkWorkflow script include provides methods to walk a workflow and return a list of successors for each activity along with a shortest path order that indicates the activity depth in the workflow.

The WFActivityHandler script include is the base class for all workflow activities.

The WindowsOSNameHelper script include provides methods to handle the formatting of Windows OS names.

The Workflow script include provides methods that interface with the Workflow engine.

The WorkflowDuration script include provides methods to calculates the duration (in seconds) based on the variables of a workflow activity. It is an interface between Workflow Timer() and DurationCalculator().

The WorkflowModelManagerAjax script include provides an AjaxProcessor wrapper for the WorkflowModelManager script include. This class derives from AbstractAjaxProcessor.

The WorkflowModelManager script include provides methods to query the workflow model, to step backwards and forwards between specified workflow history items, and to query the history for activity and transition-specific information.

The WorkflowScheduler script include provides a method to start a workflow.

The scoped Workflow API provides methods that can be used in an activity definition script.

The WorkflowTimeline script include provides methods to generate a view that shows a workflow context on the timeline.

The XMLDocument2 API is a JavaScript object wrapper for parsing and extracting XML data from an XML string.

The XMLNodeIterator API provides methods to iterate through a node of a XML document.

The XMLNode API provides methods to query values from XML nodes. XMLNodes are extracted from XMLDocument2 objects, which contain XML strings.

The XMLUtilJS script include provides XML utility methods for JavaScript to be used with Discovery scripts.

The CatalogJS API provides methods to check and retrieve catalog-specific properties.

CatalogSearchAPI is a script include used to search and retrieve product catalog data from all application scopes.

The CdmQuery script include provides methods that enable you to query the CDM data model tree. It returns a list of node objects that are specific fields/columns in the CDM Node [sn_cdm_node] table. These values are returned as properties in the object. Every object is a node in the data model.

Creates a Cell object as a cell in a table. You can use this API to format the cell and include additional blocks, such as paragraphs and images.

The ChangeSuccess script include provides methods that return the Performance Analytics (PA) success scores for change requests (original change success score based on group), change models, and change types.

The CheckDefinitionTestBuilder script include provides methods that enable you to building test check requests on check definitions.

The CheckInstanceTestBuilder script include provides methods that enable building test check requests on check instances.

The CIActionEngine API provides methods that enable you to execute any action on a configuration item (CI), to check the authorization of a user before executing an action, and to get the status and action outputs of any action execution request.

The ClassificationSolution API is a scriptable object used in Predictive Intelligence stores.

Enables storing and retrieving solutions.

The ClassificationSolutionVersion API is a scriptable object used in Predictive Intelligence stores.

The Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase database, and to receive the results of the transforms.

Manages test job generation to be executed in a cloud runner for Automated Test Framework (ATF). This API is part of the CloudRunnerApi script include.

Manages tests to be executed in a cloud runner for Automated Test Framework (ATF). This API is part of the CloudRunnerApi script include.

Manages test user jobs to be executed in a cloud runner for Automated Test Framework (ATF). This API is part of the CloudRunnerApi script include.

The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.

Enables storing and retrieving solutions.

The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.

The CMDBDuplicateTaskUtils script include provides methods to create a de-duplication task that contains duplicate configuration items (CIs) that are of independent type.

The CMDBDuplicateTemplateUtil script include provides methods to add and remove de-duplication tasks to/from a de-duplication template.

Provides methods to execute Configuration Management Database (CMDB) Query Builder operations in server-side scripts.

Provides methods to execute Configuration Management Database (CMDB) Query Builder operations in server-side scripts.

Creates a Color object used to define color attributes that you can apply to elements in a PDF; such as cells, tables, and lines.

The ConnectionInfo API enables you to get connection attribute information through the connection and credential alias.

The ConnectionInfoProvider API provides methods to select connection information through the connection alias.

The Console API provides methods to log messages to the system log, create and stop timers, create and log counters, log stack traces, and group/organize related content.

The ConsolidationServiceSNC API is a script include with methods for merging and de-duplicating complex, hierarchical business data (such as contracts, quotes, line items, and entitlements) using custom logic.

The CopyDynamicSchemaAPI class provides methods and extension points for duplicating dynamic schema metadata.

The CostPlanBatchOperations script include provides methods that enable the creation of a large number of cost plan records for demands and projects using batch processing. Use this script include instead of GlideRecord to more efficiently create multiple cost plan records.

The CSBScratchpadUtil API allows consumers to share "extra" information that is outside of any other Service Exchange service, with their providers.

The CSVParser API provides methods for parsing comma-separated value (CSV) formatted records into an object or an array.

The CTIOperationRequest script include provides methods to set and get data on the current CTIOperationRequest object.

The CTIOperationResponse script include provides methods to set and get data on the current CTIOperationResponse object.

The DataBuilder API provides methods to create a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.

The Data API provides a data object that contains the results of transform performed by a sn_clotho.Client.transform() method.

The DatasetDefinition API provides methods to identify a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets don't contain the actual data.

The DCManager API enables you to group data by type.

The ScopedDCManager API enables you to group data by type.

The DecisionTableAPI class enables you to access Decision Tables data in scoped and global server-side scripts.

The DevOpsOrchestrationToolIntegrationHandler API enables processing of payloads from custom DevOps tools.

The Document API provides methods to initialize a PDF, add content, and close the PDF. After adding content, the document can be attached to a target record.

The DocumentListEntryService API provides methods for maintaining document templates in a document list.

The DocumentListService API provides methods for creating, deleting, and updating a document list.

The DocumentReferenceService API provides methods for managing document references within a target table, such as the Incidents [incident] or Knowledge [kb_knowledge] table. You can use document references to associate information with a record.

The DocumentService API provides methods for creating, deleting, and updating a document.

The DocumentVersionService API provides a service for creating and deleting document versions. Each version is an element containing the document content and is provided using a single URL or attachment. An attachment can only be added in the Document Versions [ds_document_version] table UI and not with the API.

The DSCScriptableAPI provides methods for checking the health of your domain configuration for an instance.

The DuplicateTemplate API provides methods for users to interact with de-duplication templates by enforcing a set of validations for each method.

The DynamicSchemaAPI provides methods to clear the various caches used by the dynamic schema implementation.

The DynamicTranslation API provides methods that translate text, in real time, into multiple languages using translation service providers.

The Encoder API provides a scriptable object used in Predictive Intelligence stores. This object converts input data into vectors of numbers, based on encoder-specific goals and configurations. Encoders can be used independently to run encodings or can be configured as part of solutions to encode text columns.

The EncoderStore API provides methods to store and retrieve encoders.

The EncoderVersion API provides a scriptable object used in Predictive Intelligence stores.

The Event API provides methods that enable the setting and getting of values within an event.

The EventProcessorUtilOOB script include provides methods to construct and publish events on the configured message broker.

The EventQueueProcessorOOB script include provides methods to manage event requests on the inbound event queue (located in the Inbound Queue [sn_tmt_core_inbound_queue] table).