Read any API endpoint (generic request)

Uses the generic_request endpoint to access any ServiceNow API. Use the ServiceNow API Reference and Query Builder to build custom requests.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT *
FROM generic_request
WITH(
	Url='/v2/table/incident?sysparm_limit=10000&sysparm_query=numberLIKE0001^ORDERBYsys_created_on',
	Filter='$.result',
	Meta='sys_id:string;number:string;business_stc:int', --//comment this to see all columns (SLOW)
	PagingMode='ByResponseHeaderRfc5988'
  --Method='GET',
  --Body='{your POST body}'  
)

-- Request URL should be partial like this one:
-- /v2/some_table?some-parameter=somevalue1&some-parameter=somevalue2

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SERVICENOW_IN_GATEWAY], 'SELECT *
FROM generic_request
WITH(
	Url=''/v2/table/incident?sysparm_limit=10000&sysparm_query=numberLIKE0001^ORDERBYsys_created_on'',
	Filter=''$.result'',
	Meta=''sys_id:string;number:string;business_stc:int'', --//comment this to see all columns (SLOW)
	PagingMode=''ByResponseHeaderRfc5988''
  --Method=''GET'',
  --Body=''{your POST body}''  
)

-- Request URL should be partial like this one:
-- /v2/some_table?some-parameter=somevalue1&some-parameter=somevalue2')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_SERVICENOW_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM generic_request
WITH(
	Url=''/v2/table/incident?sysparm_limit=10000&sysparm_query=numberLIKE0001^ORDERBYsys_created_on'',
	Filter=''$.result'',
	Meta=''sys_id:string;number:string;business_stc:int'', --//comment this to see all columns (SLOW)
	PagingMode=''ByResponseHeaderRfc5988''
  --Method=''GET'',
  --Body=''{your POST body}''  
)

-- Request URL should be partial like this one:
-- /v2/some_table?some-parameter=somevalue1&some-parameter=somevalue2'
EXEC (@MyQuery) AT [LS_TO_SERVICENOW_IN_GATEWAY]