Skip to tutorial content
Rate module Not yet rated

SOAP Web Services

2 min read
On this page

In this lesson, you will learn:

  • What SOAP web services are
  • How direct web services and WSDLs work
  • How SOAP compares with REST

1 The older way to integrate

Before REST became popular, many systems used SOAP. Some older tools still do, so ServiceNow supports it too. 📜

Key term: SOAP

A web service style that sends XML messages. Each service is described in a WSDL, a file that lists what it can do.

2 Direct web services

Every table in ServiceNow already has a SOAP web service. Add ?WSDL to the table’s address to see it:

https://snwr.service-now.com/incident.do?WSDL

A SOAP call to the SNWR instance. The WSDL at incident.do?WSDL lists the available functions: get, getKeys, getRecords, insert, update, and deleteRecord. An outside system sends an XML request, insert, with short_description Printer offline. ServiceNow replies with an XML response containing the new sys_id and number INC0010052. The integration user needs roles like soap_create.
Figure 1. XML in, XML out, described by the WSDL.
Function Does
get / getRecords Read one record / many records
getKeys Get the sys_ids that match a query
insert Create a record
update Update a record
deleteRecord Delete a record

📝 Note: SOAP users need SOAP roles, like soap_query (read), soap_create, soap_update, and soap_delete, or the general soap role. ACLs still apply.

3 SOAP vs REST

SOAP REST
Message format XML Usually JSON
Described by WSDL API docs (REST API Explorer)
Feel Strict and heavier Simple and lightweight
Today Mostly older systems The usual choice for new integrations

💡 Good to know: ServiceNow can call other SOAP services too. Build an outbound SOAP Message in System Web Services > Outbound > SOAP Message.

⭐ Remember: SOAP = XML + WSDL. Add ?WSDL to a table URL. New integrations usually use REST.

4 Let’s try it: open a WSDL

  1. In your browser, open https://<your-pdi>.service-now.com/incident.do?WSDL.
  2. Search the page for insert and getRecords. Can you find them?
  3. Open User Administration > Roles and search for roles starting with soap. Which ones exist?

5 Quick recap

  • SOAP uses XML messages described by a WSDL
  • Every table has a direct SOAP web service: add ?WSDL
  • Functions: get, getRecords, getKeys, insert, update, deleteRecord
  • SOAP users need soap roles, and ACLs still apply
  • REST is the usual choice for new work

6 Check yourself

Think of your answer first. Then tap to check.

1 What do you add to a table URL to see its SOAP description? Show answer

?WSDL

2 Which message format does SOAP use? Show answer

XML.

3 Which role lets a SOAP user create records? Show answer

soap_create (or the general soap role).

Nice work! You finished this lesson. 🎉

Was this lesson helpful?

Have a question or doubt?

Ask here and get help from instructors and fellow learners.

0 / 300

Only logged-in learners can post.