JSON Data Modification API
Summarize
Summary of JSON Data Modification API
The JSON Data Modification API allows ServiceNow customers to modify data through HTTPS POST requests. This API supports various actions, such as inserting, updating, and deleting records in ServiceNow by sending JSON objects to specific endpoints.
Show less
Key Features
- Insert: Create a new record by posting a JSON object. Example: {"shortdescription":"this is a test","priority":"1"}.
- Insert Multiple: Create multiple records by sending an array of JSON objects. Example: {"records":[{"shortdescription":"test 1","priority":"1"},{"shortdescription":"test 2","priority":"1"}]}.
- Update: Modify existing records filtered by an encoded query using the sysparmquery parameter. Example: {"shortdescription":"updated","priority":"3"}.
- Delete Record: Remove a single record using the sysparmsysid parameter. Example: {"sysparmsysid":"fd4001f80a0a0b380032ffa2b749927b"}.
- Delete Multiple: Delete multiple records based on a query string. Example: {"sysparmquery":"shortdescription=test"}.
Key Outcomes
By utilizing the JSON Data Modification API, ServiceNow customers can efficiently manage records in their instances, automate data operations, and streamline workflows. The API's structure allows for precise data manipulation while providing JSON responses for easy integration with other systems.
Modify data using the JSON web service by sending an HTTPS POST request to the instance.
sysparm_action
parameter to indicate the type of action to be performed, with the incoming JSON object post in
the body.insert
Create a new record in ServiceNow. The JSON object has to be POSTed as the body (content-type is usually application/json, although not enforced). The response from the record creation is a JSON object of the incident that was created.
{"short_description":"this is a test","priority":"1"}https://your_instance.service-now.com/incident.do?JSONv2&sysparm_action=insertcreates an incident.
{"sysparm_action":"insert","short_description":"this is a test","priority":"1"}insertMultiple
{ "records" : [ { "short_description" : "this was inserted with python using JSON 1" , "priority" : "1 - Critical" , "impact" : "1" , "caller_id" : "Fred Luddy" } , { "short_description" : "this was inserted with python using JSON 2" , "priority" : "1 - Critical" , "impact" : "1" , "caller_id" : "Fred Luddy" } ] }https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_action=insert
https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_action=insertMultiple
creates two incidents. Note the fields described as an array value for the records field.
update
Update a record or a list of records filtered by an
encoded query string
specified by the
sysparm_query
URL parameter. The JSON object has to be posted as the body (content-type is usually
application/json, although not enforced). The response from the record creation is an array of
JSON objects representing the records that were updated.
{"short_description":"this was updated with python", "priority": "3", "impact":"1"}https://instance_name.service-now.com/incident.do?JSONv2&sysparm_query=priority=3&sysparm_action=update
updates all incidents with priority 3, and sets the values specified by the JSON object.
deleteRecord
Delete a single record from the targeted table, identified by a
sysparm_sys_id
parameter. The parameter may be encoded in the input JSON object or given as a URL
parameter.
{"sysparm_sys_id":"fd4001f80a0a0b380032ffa2b749927b"}
http://instance_name.service-now.com/incident.do?JSONv2&sysparm_action=deleteRecord
deletes the incident record identified by the sys_id fd4001f80a0a0b380032ffa2b749927b.
deleteMultiple
Delete multiple records from the targeted table, filtered by an
encoded query string
specified in the
sysparm_query
URL parameter. The filter may also be encoded in the input JSON object.
{"sysparm_query":"short_description=this was updated with python"}http://instance_name.service-now.com/incident.do?JSONv2&sysparm_action=deleteMultipledeletes all incident records where the short_description field contains the
value "this was updated with python".