Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'q', 'SELECT name from Account'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/services/data/v{{version}}/queryAll/', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "totalSize": 12,
-- "done": true,
-- "records": [
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF"
-- },
-- "Name": "Edge Communications"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF"
-- },
-- "Name": "Burlington Textiles Corp of America"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF"
-- },
-- "Name": "Pyramid Construction Inc."
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF"
-- },
-- "Name": "Dickenson plc"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF"
-- },
-- "Name": "Grand Hotels & Resorts Ltd"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF"
-- },
-- "Name": "United Oil & Gas Corp."
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF"
-- },
-- "Name": "Express Logistics and Transport"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF"
-- },
-- "Name": "University of Arizona"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF"
-- },
-- "Name": "United Oil & Gas, UK"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF"
-- },
-- "Name": "United Oil & Gas, Singapore"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF"
-- },
-- "Name": "GenePoint"
-- },
-- {
-- "attributes": {
-- "type": "Account",
-- "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF"
-- },
-- "Name": "sForce"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_Type nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @totalSize int
EXEC sp_OAMethod @jResp, 'IntOf', @totalSize OUT, 'totalSize'
DECLARE @done int
EXEC sp_OAMethod @jResp, 'BoolOf', @done OUT, 'done'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'records'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'records[i].attributes.type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'records[i].attributes.url'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'records[i].Name'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "q=SELECT%20name%20from%20Account"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/queryAll/
Postman Collection Item JSON
{
"name": "QueryAll",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
},
"description": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch. Note that even though nextRecordsUrl has query in the URL, it will still provide remaining results from the initial QueryAll request. The remaining results will include deleted records that matched the initial query.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm"
},
"response": [
{
"name": "QueryAll",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 27 Sep 2023 15:27:21 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Sforce-Limit-Info",
"value": "api-usage=2/15000"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"totalSize\": 12,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF\"\n },\n \"Name\": \"Edge Communications\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF\"\n },\n \"Name\": \"Burlington Textiles Corp of America\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF\"\n },\n \"Name\": \"Pyramid Construction Inc.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF\"\n },\n \"Name\": \"Dickenson plc\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF\"\n },\n \"Name\": \"Grand Hotels & Resorts Ltd\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF\"\n },\n \"Name\": \"United Oil & Gas Corp.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF\"\n },\n \"Name\": \"Express Logistics and Transport\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF\"\n },\n \"Name\": \"University of Arizona\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF\"\n },\n \"Name\": \"United Oil & Gas, UK\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF\"\n },\n \"Name\": \"United Oil & Gas, Singapore\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF\"\n },\n \"Name\": \"GenePoint\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF\"\n },\n \"Name\": \"sForce\"\n }\n ]\n}"
}
]
}
