Welcome to Community Week 2025! Join us to learn, connect, and be recognized as we celebrate the spirit of Community and the power of AI. Get the details  

How to troubleshoot REST API ?

ram2497
Tera Contributor

‎08-10-2020 02:02 AM

How to troubleshoot the REST API?

 

Thanks

Ram

0 Helpfuls
  • 1,914 Views
3 REPLIES 3

Sudhanshu Talw1
Tera Guru

‎08-10-2020 02:08 AM

Hi,

Trouble shooting REST API is basically you should have idea about all the status codes.

For error codes:

https://docs.servicenow.com/bundle/london-application-development/page/app-store/good_practices/scri...

You should log status code of the response. That's a good practice to keep check did you hit the API correctly.

Following link is helpful:

https://developer.servicenow.com/blog.do?p=/tags/troubleshooting/

https://developer.servicenow.com/blog.do?p=/post/debugging-inbound-rest-calls-and-the-business-rules...

 Apart from it if you are unable to access an API, try with POSTMAN.

  

Thanks

Sudhanshu

0 Helpfuls

Hitoshi Ozawa
Giga Sage
Giga Sage

‎08-10-2020 02:23 AM

For inbound REST, I usually use some tool first to test if the external REST API is actually working as it should and to confirm the parameters.

I mostly just use the curl command because I can script it and save the script so I can later use it for test.

Calling from REST API isn't too much trouble after that.

 

For outbound REST, I usually write a server script to make sure the logic is correct. Then create the API and again use curl to test the API.

To troubleshoot, I usually go back to my curl scripts and the server scripts.