---
sourceDocument: Yokohama API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama 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: Yokohama
* 
* Updated January 30, 2025
* 
* ![](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://www.servicenow.com/docs/SokPSZsolwJhJ5qyDAttyg "Creates a new record for the table targeted in the URL.") | Creates a new record for the table targeted in the URL. |
| [insertMultiple](https://www.servicenow.com/docs/WghHL302N109gsRFGpXpjA "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=yokohama&pubname=yokohama-integrate-applications&ft:locale=en-US). |
| [update](https://www.servicenow.com/docs/BuA4DFNpfMDE1gNZ_602tg "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://www.servicenow.com/docs/D8GrX20bdcQLAwtA4uQY~A "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://www.servicenow.com/docs/yr2UD6aSn8XosWvXCHjubA "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://www.servicenow.com/docs/xE0yXZaDTGSWXeIGpZp2aA "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://www.servicenow.com/docs/PqkurE7DhVcU__2fySpmLA "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://www.servicenow.com/docs/ClBZsYDkUeJPb8LgWYmqJA "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://www.servicenow.com/docs/bs7u~1efBXprXEZc~kTziQ)**   
  Data Retrieval API method summaries and descriptions.
* **[Data Modification API](https://www.servicenow.com/docs/jFiXKJexBrQFoEEbUbst5g)**   
  Data Modification API method summaries and descriptions.

**Related concepts**   

* [Use forms to limit or extend the query response](https://www.servicenow.com/docs/mEjcu3ttq8b8dEIHv_3GZg "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://www.servicenow.com/docs/Q4oorUfcspaG5qKp1QMNXg "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://www.servicenow.com/docs/YXJ8Eg5KFoE~zjxWo1f3Fg "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://www.servicenow.com/docs/t0wHqZm7rW9MoSCMkR44Ew "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://www.servicenow.com/docs/uGazlJUjcetOoqWG89t3Iw "To retrieve or set choice fields, use the choice Value, not the Label.")
* [Persist an HTTP session across all SOAP calls](https://www.servicenow.com/docs/cWAq~1~hykVOFevCCSWSIw "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.")