Core Concepts of Inbound REST API

-


  • Use the REST API Explorer to create and test inbound ServiceNow API requests.
  • Path parameters are part of the endpoint URL. 
  • Query parameters determine which records, which data, and the data format returned in the response body.
  • The HTTP status code indicates the status of the transaction request and does not indicate any information about the returned data.
  • The response body format is set in the headers.
  • The REST API Explorer tests requests as the currently logged in user.
  • The Allow access to this table via web services option cannot be tested in the REST API Explorer.
  • Do not use the admin user in code integrations, create a web services only user instead.
  • Disable web service access to tables with sensitive data unless web service access is required
  • CORS rules add security to APIs
  • CORS rules determine which cross-origin resources can access which methods. 
  • CORS rules cannot be tested in the REST API Explorer. 
  • Code samples provide script stubs for integrating into ServiceNow from third party applications. 
  • Developers must update credentials in the code samples. 
  • Code samples are available in multiple standard languages used with integrations. 

Comments

Post a Comment

Popular posts from this blog

Background Scripts

-
BACKGROUND SCRIPT CODE VAULT RECORD QUERIES ACTIVE REQUESTS WITHOUT REQUESTED ITEMS (function() { var grRequest = new GlideRecord("sc_request"); grRequest.addEncodedQuery("active=true"); grRequest.query(); gs.print('Active Requests without Requested Items :('); while (grRequest.next()) { var gaRequestedItem = new GlideAggregate("sc_req_item"); gaRequestedItem.addQuery("request",grRequest.sys_id); gaRequestedItem.addAggregate('COUNT'); gaRequestedItem.query(); var req = 0; if (gaRequestedItem.next()) { req = gaRequestedItem.getAggregate('COUNT'); if (req == 0) { gs.print(grRequest.number); } } } })(); DISTINCT OPERATING SYSTEMS OF CIS (function() { var gaServer = new GlideAggregate('cmdb_ci_server'); //GlideAggregate query gaServer.addAggregate('count'); //Count aggregate (only necessary for a count of items of each OS) gaServer.orderByAggregate('count'); //Count aggregate ordering gaServe...
Read more

Glide Record Cheat Sheet

-
Query Can also be used in Client scripts and UI policies A standard GlideRecord query follows this format. var  gr  =   new  GlideRecord ( 'incident' ) ;   //Indicate the table to query from //The 'addQuery' line allows you to restrict the query to the field/value pairs specified (optional) //gr.addQuery('active', true); gr. query ( ) ;   //Execute the query while  ( gr. next ( ) )   {   //While the recordset contains records, iterate through them     //Do something with the records returned     if ( gr. category   ==   'software' ) {       gs. log ( 'Category is '   +  gr. category ) ;     } } UPDATE:  This same function applies to client-side GlideRecord queries! If at all possible, you should use an  asynchronous  query from the client.  See this post  for details. var  gr  =   new  GlideRecord ( 'sys_user' ) ; ...
Read more

Setup OAuth2 authentication for RESTMessageV2 integrations

-
Image
1. Configure OAuth provider on instance 1 (OAuth Application Registry -> Create an OAuth API endpoint for external clients) Create unique provider profile name. We need to generate client ID along with Client Secret. Both can be generated by system normally. Token lifespan are optional, generated by default system policy. 2. Configure OAuth consumer on instance 2 (OAuth Application Registry -> Connect to a third party OAuth Provider) Create unique consumer profile name. (very important, script will need pass in this consumer profile name as parameter) Client ID and Client secret are the values were generated from step 1. Grant type. Value can be either "password" or "refresh_token". Suggest to use password since you won't have refresh_token info initially. This refresh_token only will be generated during first time when access token is generated. Token URL will be provided by OAuth provider. In this example, it would be the  https://oauth_...
Read more