Parameterized Search for a String - Fetch

Search for a string by Parameterized Search in Salesforce using SQL Server

Prerequisites:

See SQLHTTP easy setup for Salesforce
See API Call documentation for parameter values and other information
Create the stored procedure documented below

Stored Procedure:


CREATE PROCEDURE usp_SalesForce_String_Parameterized_Search(	
		@Profile nvarchar(100),	
		@APIVersion varchar(6), 
		@SearchString varchar(MAX),
		@Response nvarchar(MAX) OUTPUT,
		@StatusCode int OUTPUT,
		@StatusDescription nvarchar(MAX) OUTPUT)
AS

IF @APIVersion NOT LIKE 'v[0-9]%'
	BEGIN
		RAISERROR('Invalid API Version. Example: v20.0', 16, 1)
		RETURN
	END

IF ISNUMERIC(SUBSTRING(@APIVersion, 2, LEN(@APIVersion))) = 0
	BEGIN
		RAISERROR('Invalid API Version. Example: v20.0', 16, 1)
		RETURN
	END


DECLARE @URL nvarchar(MAX)
DECLARE @QueryString varchar(MAX)
DECLARE @HTTPSessionID uniqueidentifier

SET @URL = SQLHTTP.net.AuthParam(@Profile, 'InstanceURL')

EXEC SQLHTTP.net.UrlBuilder   @URL OUTPUT,
			      @Profile,
			      'services','data', @APIVersion, 'parameterizedSearch'

EXEC SQLHTTP.net.QueryStringBuilder   @QueryString OUTPUT,
				      @Profile,
				      'q', @SearchString

SET @URL = @URL + '/' + @QueryString

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Salesforce_Auth_Header @Profile, @HTTPSessionID

EXEC SQLHTTP.net.HTTPRequest 	@HttpSessionID,
				@URL = @URL,
				@Method = 'GET',
				@Accept = 'application/json',
				@StatusCode = @StatusCode OUTPUT,
				@StatusDescription = @StatusDescription OUTPUT,
				@Response = @Response OUTPUT
GO

CREATE PROCEDURE usp_SalesForce_String_Parameterized_Search(

@Profile nvarchar(100),

@APIVersion varchar(6),

@SearchString varchar(MAX),

@Response nvarchar(MAX) OUTPUT,

@StatusCode int OUTPUT,

@StatusDescription nvarchar(MAX) OUTPUT)

IF @APIVersion NOT LIKE 'v[0-9]%'

BEGIN

RAISERROR('Invalid API Version. Example: v20.0', 16, 1)

RETURN

END

IF ISNUMERIC(SUBSTRING(@APIVersion, 2, LEN(@APIVersion))) = 0

BEGIN

RAISERROR('Invalid API Version. Example: v20.0', 16, 1)

RETURN

END

DECLARE @URL nvarchar(MAX)

DECLARE @QueryString varchar(MAX)

DECLARE @HTTPSessionID uniqueidentifier

SET @URL = SQLHTTP.net.AuthParam(@Profile, 'InstanceURL')

EXEC SQLHTTP.net.UrlBuilder @URL OUTPUT,

@Profile,

'services','data', @APIVersion, 'parameterizedSearch'

EXEC SQLHTTP.net.QueryStringBuilder @QueryString OUTPUT,

@Profile,

'q', @SearchString

SET @URL = @URL + '/' + @QueryString

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Salesforce_Auth_Header @Profile, @HTTPSessionID

EXEC SQLHTTP.net.HTTPRequest @HttpSessionID,

@URL = @URL,

@Method = 'GET',

@Accept = 'application/json',

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT,

@Response = @Response OUTPUT



Sample Usage:


DECLARE @Response nvarchar(MAX)
DECLARE @StatusCode int
DECLARE @StatusDescription nvarchar(MAX)
DECLARE @Profile nvarchar(100)

SET @Profile = 'My Salesforce'

--Salesforce Bearer Token is valid for only a few hours
EXEC usp_Salesforce_Auth_Refresh @Profile

EXEC usp_SalesForce_String_Parameterized_Search
		@Profile = @Profile,
                @APIVersion = 'v40.0',
		@SearchString = 'Andy',
		@Response = @Response OUTPUT, 
		@StatusCode = @StatusCode OUTPUT, 
		@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400
	EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response
ELSE
	BEGIN
		
		DECLARE @X xml
		SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

		--The XPath syntax below was easily generated by executing the following commands:
		--EXEC SQLHTTP.net.XQueryHelper @X
		--and then executing: 
		--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/searchRecords/JsonObject'

		SELECT  T.C.value(N'@Id', N'nvarchar(MAX)') AS [Id]
		       ,T.C.value(N'attributes[1]/@type', N'nvarchar(MAX)') AS [type]
		       ,T.C.value(N'attributes[1]/@url', N'nvarchar(MAX)') AS [url]
		FROM @X.nodes(N'/JsonObject/searchRecords/JsonObject') T(C)

	END

DECLARE @Response nvarchar(MAX)

DECLARE @StatusCode int

DECLARE @StatusDescription nvarchar(MAX)

DECLARE @Profile nvarchar(100)

SET @Profile = 'My Salesforce'

--Salesforce Bearer Token is valid for only a few hours

EXEC usp_Salesforce_Auth_Refresh @Profile

EXEC usp_SalesForce_String_Parameterized_Search

@Profile = @Profile,

@APIVersion = 'v40.0',

@SearchString = 'Andy',

@Response = @Response OUTPUT,

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400

EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response

ELSE

BEGIN

DECLARE @X xml

SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

--The XPath syntax below was easily generated by executing the following commands:

--EXEC SQLHTTP.net.XQueryHelper @X

--and then executing:

--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/searchRecords/JsonObject'

SELECT T.C.value(N'@Id', N'nvarchar(MAX)') AS [Id]

,T.C.value(N'attributes[1]/@type', N'nvarchar(MAX)') AS [type]

,T.C.value(N'attributes[1]/@url', N'nvarchar(MAX)') AS [url]

FROM @X.nodes(N'/JsonObject/searchRecords/JsonObject') T(C)

END

Id type url

------------------- ---------------- --------------------------------------------------------

0030Y00000RzEOkQAN Contact /services/data/v40.0/sobjects/Contact/0030Y00000RzEOkQAN

00Q0Y0000066wKYUAY Lead /services/data/v40.0/sobjects/Lead/00Q0Y0000066wKYUAY

0010Y000019ojWHQAY Account /services/data/v40.0/sobjects/Account/0010Y000019ojWHQAY



IMPORTANT DISCLAIMER

CODE/SQL ON THESE PAGES ARE PROVIDED AS-IS AND ARE AVAILABLE FOR ILLUSTRATIVE PURPOSES ONLY.

USERS ARE REQUIRED TO ABIDE BY THE TERMS AND CONDITIONS FOR USING REFERENCED THIRD PARTY WEBSITES AND/OR APIs FROM THEIR RESPECTIVE WEBSITES. WE DO NOT CONDONE ANY VIOLATION OF THIRD PARTY WEBSITES AND/OR APIs TERMS AND CONDITIONS USING OUR SOFTWARE.

USERS SHALL BE SOLELY RESPONSIBLE AND BE SOLELY LIABLE FOR VIOLATION OF ANY RULES SPECIFIED BY THIRD PARTIES FOR USING THEIR WEBSITES AND/OR APIs, OR INFRINGEMENT OF RIGHTS OF SUCH THIRD PARTIES.