How-to - Debug a CI Sync Payload via REST API Explorer?

Aim

This article explains how to test a CISync update payload submission against ServiceNow

If you run a sync job and the value/s from the source system don’t populate the ServiceNow field/s as expected you can use REST API Explorer to attempt to update the field/s.

Process

As a ServiceNow system admin navigate to the REST API Explorer

REST API Explorer 1.jpg
  1. Select "Update a record (PATCH)"

  2. Select the table (in this example cmdb_ci_vm_instance)

  3. Enter the sys_id of the record to update (this will be the Destination Key on the record in the CI Sync job)

REST API Explorer 7.jpg
  1. Enter the "Raw" payload. This will be the Transformed Payload from the CISync record Task ID. i.e. you copy the Transformed Payload for the record then paste it into the field in the Raw tab.

Then click Send

This will submit the payload in the context of the current user (i.e. an Admin user, which bypasses many ACLs).

If this submission works, but CISync is not working, try again impersonating the Integration User, e.g. cisync.integration. But first:

  1. Find the Integration account and open it.

  2. Then verify the cisync.integration user does NOT have the "Internal Integration User" enabled:

REST API Explorer 2.jpg

Then add the "rest_api_explorer" role to the cisync.integration user (to allow the Integration user to run REST API Explorer)

Click Edit.

REST API Explorer 3.jpg

Type Rest in the Collection search box. Click rest_api_explorer to highlight it. Click the right arrow to add the role.

REST API Explorer 4.jpg

Click Save

REST API Explorer 5.jpg



Then:

  1. Impersonate the "cisync.integration" user.

  2. Repeat the steps carried out against the REST API Explorer defined above.

N/A

Control Information

Created

Reviewed

Data Classification

PUBLIC
Classified in accordance with the Syncfish Data Classification Framework