API reference

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of API Reference

    The API reference for ServiceNow provides essential information for utilizing APIs to enhance functionalities on the ServiceNow AI Platform. This document outlines how to control client-side behaviors, build mobile experiences, develop applications, and manage data effectively using various API methods.

    Show full answer Show less

    Key Features

    • Client APIs: Control the behavior and display of the ServiceNow AI Platform in web browsers using client-side JavaScript APIs such as GlideAjax for server-side calls and GlideForm for form customization.
    • Client Mobile: Use Cabrillo JS to access native mobile application capabilities and functionalities within the ServiceNow AI Platform.
    • UI Builder: Implement client scripts in UI Builder that respond to user interactions or lifecycle events.
    • Server APIs: Modify existing applications or create new ones with server-side JavaScript APIs like GlideRecord for data operations and GlideSystem for accessing instance information.
    • REST APIs: Access and update data through REST APIs, discoverable via the REST API Explorer, with options to create custom APIs as needed.

    Key Outcomes

    By leveraging these APIs, ServiceNow customers can effectively customize their applications, enhance user experiences, and streamline data management processes. This empowers customers to create tailored solutions that meet their organizational needs while ensuring efficient interaction with the ServiceNow platform.

    Use ServiceNow APIs to change functionalities and add features on the ServiceNow AI Platform.

    Client

    Use client-side JavaScript APIs to control how the ServiceNow AI Platform functions and displays within the web browser. Client-side APIs provide common functionality that you can add to your instance by calling the APIs from client-side scripts such as client scripts and UI policy scripts.

    Common use cases:
    • Use the GlideAjax API to call server-side code from a client script.
    • Use the GlideForm API to customize forms.

    Client mobile

    Cabrillo JS is a client-side JavaScript API for accessing capabilities inside ServiceNow AI Platform native mobile applications. Cabrillo JS provides methods to use native device capabilities, native mobile UI, and other ServiceNow AI Platform mobile functionality.

    UI Builder

    Use UI Builder APIs when developing client scripts in the UI Builder. Client scripts are executed in response to something happening on a page, such as:
    • User interaction events/actions, such as a button click.
    • Lifecycle events, such as a data broker execution started.

    Server

    Use server-side JavaScript APIs to change the functionality of existing applications or to build new applications. Server-side APIs provide common functionality that you can add to your instance by calling the APIs from server-side scripts such as business rules and script includes. Scoped APIs are intended for use with scoped applications, and global APIs are intended for use with applications in the global scope. New applications are typically scoped. Applications in the global scope are typically legacy applications.

    Common use cases:
    • Use the GlideRecord or GlideQuery APIs to perform create, read, update, and delete operations on record data from server-side scripts.
    • Use the GlideSystem API to access information about the instance or the current user session and to write informational or error messages.
    • Use FlowAPI methods to trigger flows, subflows, and actions from server-side scripts.

    REST

    Use REST APIs to access and update data on the ServiceNow AI Platform. You can discover these APIs from within your instance by using the REST API Explorer. If you don't find an API that meets your needs, you can create custom REST APIs using the Scripted REST API feature. ServiceNow REST APIs support Basic Authentication and OAuth 2.0 to authenticate requests.

    Common use cases:
    • Use the Attachment API to upload and query file attachments.
    • Use the Email API to send and receive email messages.
    • Use the Table API to create, read, update, and delete records in a table.