SOAP direct web service API functions

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • The standard SOAP API is a set of small, globally defined functions that can be performed on a targeted resource.

    The targeted resource (or table) is defined in the URL by the format https://<instance name>.service-now.com/<table name>.do.

    Table 1. Data Modification API
    Method Summary Description
    insert Creates a new record for the table targeted in the URL.
    insertMultiple Creates multiple new records for the table targeted in the URL. To enable multiple inserts, activate the Web service import sets.
    update Updates a existing record in the targeted table in the URL, identified by the mandatory sys_id field.
    deleteRecord Deletes a record from the targeted table by supplying its sys_id.
    deleteMultiple Delete multiple records from the targeted table by example values.
    Table 2. Data Retrieval API
    Method Summary Description
    getKeys Query the targeted table by example values and return a comma delimited sys_id list.
    getRecords Query the targeted table by example values and return all matching records and their fields.
    get Query a single record from the targeted table by sys_id and return the record and its fields.
    aggregate Query using and aggregate functions SUM, COUNT MIN, MAX, LAST, and AVG. To enable the aggregate functions, activate the Aggregate Web Service Plugin.