Incident REST detailed documentation

[patricktownsend]

Hello, I am developing a custom client implementation that will create new incidents in ServiceNow using the REST interface. I am looking for detailed documentation on the fields that can be passed in the payload. I've used the on-line REST API tester interface. I can see that there are many fields that are supported in the request payload, but I need some detailed documentation on these fields that includes a full list of the available fields. Is there a full PDF or on-line reference for the Incident REST interface? Thanks.

[Community Alums · Accepted solution]

Patrick,

This is your own personal developer instance? And you're logging in as admin? Or are you logging in to a client instance with limited access?

There are a couple of ways you can handle what you want to do. If the IBM system can send an email, you can send an email to the servicenow instance, and you can script an inbound action to create whatever type of record you want. Problem is a different table/process, but you can very well create a Problem record as opposed to an Incident; it really depends on the internal process and how you want to handle the incoming record.

The second option (and third) would be to use the REST API in servicenow; a)   the table API which already exists or b) write a scripted rest api to handle the incoming REST request and create the record that way.

Email is probably the easiest/quickest, depending on if you require additional scripting to create anything the than an incident. Otherwise, if you just send an email to your instance, the default inbound email action will create an Incident.

Hopefully that clarifies a couple of things for you, let me know if you need any other assistance!

Cheers,

Tim

[patricktownsend]

Thanks Tim! This is my developer instance and I am logging in as "admin". I do have an email client on the IBM server, but I am going to give the REST table API a try.   I've managed to raise a problem using the REST API explorer and I think I understand the HTTP headers and JSON fields. Again, appreciate the help!

Patrick

[Community Alums]

No worries, good luck man!

Cheers,

Tim

[Alikutty A]

Here are some interesting documents on REST API

TechNow Episode 18 | REST API

New REST API docs on the developer portal!

How to Consume Third-Party REST Web Services

If you have custom logic required to be implemented, I would suggest you integrate REST via web service import set tables vs the direct rest API as you would get more control over the API

Thank You

Please Hit Like, Helpful or Correct depending on the impact of response

[patricktownsend]

Hi Alikutty,

Thank you for these links. I researched them and can see the documentation on the import of the incident table. I still have a question about which fields are available for importing. Is there a list of the fields for the Incident? I would rather use the actual Incident table field names rather than creating a mapping table.

Thanks for your help,

Patrick