---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SOAP direct web service API functions

# SOAP direct web service API functions {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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`.
{#r_DirectWebServiceAPIFunctions__id_brv_hgt_3xb__entry__2}

| Method Summary | Description |
|-|-|
| [insert](https://servicenow-prod.fluidtopics.net/fPrjCXLHhIQT~Qr8Njmlig "Creates a new record for the table targeted in the URL.") | Creates a new record for the table targeted in the URL. |
| [insertMultiple](https://servicenow-prod.fluidtopics.net/AuSx75YXrxc9KBArAq3rvA "Creates multiple new records for the table targeted in the URL.") | Creates multiple new records for the table targeted in the URL. To enable multiple inserts, activate the [Web service import sets](https://www.servicenow.com/docs/access?context=c_WebServiceImportSets&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US). |
| [update](https://servicenow-prod.fluidtopics.net/_Toc1eHU69Zp_0lZo3jH8A "Updates an existing record in the targeted table in the URL, identified by the mandatory sys_id field.") | Updates a existing record in the targeted table in the URL, identified by the mandatory sys_id field. |
| [deleteRecord](https://servicenow-prod.fluidtopics.net/tuysqdOk1TDP7zyF6kWCag "Delete a record from the targeted table by supplying its sys_id.") | Deletes a record from the targeted table by supplying its `sys_id`. |
| [deleteMultiple](https://servicenow-prod.fluidtopics.net/zLh1ttpWj3MvhMqzo8oFXQ "Delete multiple records from the targeted table by example values.") | Delete multiple records from the targeted table by example values. |
[Table 1. Data Modification API]

{#r_DirectWebServiceAPIFunctions__id_brv_hgt_3xb} {#r_DirectWebServiceAPIFunctions__id_wz4_3gt_3xb__entry__2}

| Method Summary | Description |
|-|-|
| [getKeys](https://servicenow-prod.fluidtopics.net/TwwR8WSM4nWfSkU5m5oZXA "Query the targeted table by example values and return a comma delimited sys_id list.") | Query the targeted table by example values and return a comma delimited `sys_id` list. |
| [getRecords](https://servicenow-prod.fluidtopics.net/vU542w8i0gI92wMPjG3Fcw "Query the targeted table by example values and return all matching records and their fields.") | 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](https://servicenow-prod.fluidtopics.net/7aRKeAz_CQtdMuUSgS6uuw "Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG.") | Query using and aggregate functions SUM, COUNT MIN, MAX, LAST, and AVG. To enable the aggregate functions, activate the Aggregate Web Service Plugin. |
[Table 2. Data Retrieval API]

{#r_DirectWebServiceAPIFunctions__id_wz4_3gt_3xb}
* **[Data Retrieval API](https://servicenow-prod.fluidtopics.net/ozcWm7XT3ZVB5FfxZW2sMA)**   
  Data Retrieval API method summaries and descriptions.
* **[Data Modification API](https://servicenow-prod.fluidtopics.net/Sp6np4pwn2KhzWGpcxvAdw)**   
  Data Modification API method summaries and descriptions.

**Related concepts**   

* [Use forms to limit or extend the query response](https://servicenow-prod.fluidtopics.net/m7tyIZhLJata4jEK0zNK0A "On occasion, there is a need to limit the number of field values that a SOAP query returns.")
* [Return the display value for reference variables](https://servicenow-prod.fluidtopics.net/ghcpgTLmrDFjbwT8JPlfZQ "When you query a record using a get or getRecords function, the instance returns all fields associated with that record. The fields are often reference fields that contain a sys_id for a record on another table.")
* [Clear values from a target instance](https://servicenow-prod.fluidtopics.net/ibHtp5YxHam~07bgelX3KA "You can pass an empty value through a SOAP parameter to clear the respective value in the target instance.")
* [Retrieve journal entries using direct web services](https://servicenow-prod.fluidtopics.net/We_rrkdN~9_4C2eEVbCrFQ "To get the contents of a journal field, make a second soap request against the sys_journal_field table to pull the appropriate journal records back for the record in question.")
* [Retrieve choice fields using direct web services](https://servicenow-prod.fluidtopics.net/UKRQMVoU2VrWpJeY0VWVIw "To retrieve or set choice fields, use the choice Value, not the Label.")
* [Persist an HTTP session across all SOAP calls](https://servicenow-prod.fluidtopics.net/iS3ozZygbwJT8~rXNxSVcA "In circumstances when a SOAP client makes many calls in a short amount of time, you may want to re-use a single HTTP session for all SOAP calls.")