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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "query": "query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
-- "variables": "{\n \"month\": 10\n}"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'query', 'query opportunitiesClosingSoon($month: Long) {' + CHAR(10) + ' uiapi {' + CHAR(10) + ' query {' + CHAR(10) + ' Opportunity(' + CHAR(10) + ' where: {' + CHAR(10) + ' StageName: { eq: "Negotiation/Review" }' + CHAR(10) + ' CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }' + CHAR(10) + ' }' + CHAR(10) + ' ) {' + CHAR(10) + ' edges {' + CHAR(10) + ' node {' + CHAR(10) + ' Id' + CHAR(10) + ' Name {' + CHAR(10) + ' value' + CHAR(10) + ' }' + CHAR(10) + ' StageName {' + CHAR(10) + ' value' + CHAR(10) + ' }' + CHAR(10) + ' CloseDate {' + CHAR(10) + ' value' + CHAR(10) + ' displayValue' + CHAR(10) + ' }' + CHAR(10) + ' Description {' + CHAR(10) + ' value' + CHAR(10) + ' }' + CHAR(10) + ' }' + CHAR(10) + ' }' + CHAR(10) + ' }' + CHAR(10) + ' }' + CHAR(10) + ' }' + CHAR(10) + '}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'variables', '{' + CHAR(10) + ' "month": 10' + CHAR(10) + '}'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-Chatter-Entity-Encoding', 'false'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/graphql', 'application/json', @json
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 @json
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 @json
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)
-- {
-- "data": {
-- "uiapi": {
-- "query": {
-- "Opportunity": {
-- "edges": [
-- {
-- "node": {
-- "Id": "00658000003ceg9AAA",
-- "Name": {
-- "value": "United Oil Refinery Generators"
-- },
-- "StageName": {
-- "value": "Negotiation/Review"
-- },
-- "CloseDate": {
-- "value": "2023-10-25",
-- "displayValue": "25/10/2023"
-- },
-- "Description": {
-- "value": "This is a sample opportunity."
-- }
-- }
-- }
-- ]
-- }
-- }
-- }
-- },
-- "errors": [
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Id nvarchar(4000)
DECLARE @Value nvarchar(4000)
DECLARE @StageNameValue nvarchar(4000)
DECLARE @CloseDateValue nvarchar(4000)
DECLARE @DisplayValue nvarchar(4000)
DECLARE @DescriptionValue nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.uiapi.query.Opportunity.edges'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.uiapi.query.Opportunity.edges[i].node.Id'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'data.uiapi.query.Opportunity.edges[i].node.Name.value'
EXEC sp_OAMethod @jResp, 'StringOf', @StageNameValue OUT, 'data.uiapi.query.Opportunity.edges[i].node.StageName.value'
EXEC sp_OAMethod @jResp, 'StringOf', @CloseDateValue OUT, 'data.uiapi.query.Opportunity.edges[i].node.CloseDate.value'
EXEC sp_OAMethod @jResp, 'StringOf', @DisplayValue OUT, 'data.uiapi.query.Opportunity.edges[i].node.CloseDate.displayValue'
EXEC sp_OAMethod @jResp, 'StringOf', @DescriptionValue OUT, 'data.uiapi.query.Opportunity.edges[i].node.Description.value'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'errors'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-Chatter-Entity-Encoding: false"
--data-raw '{"query":"query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}","variables":"{\n \"month\": 10\n}"}'
https://domain.com/services/data/v{{version}}/graphql
Postman Collection Item JSON
{
"name": "Opportunities Closing Soon",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": "{\n \"month\": 10\n}"
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"graphql"
]
}
},
"response": [
{
"name": "Opportunities Closing Soon",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": "{\n \"month\": 10\n}"
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"graphql"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:19:42 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"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 \"data\": {\n \"uiapi\": {\n \"query\": {\n \"Opportunity\": {\n \"edges\": [\n {\n \"node\": {\n \"Id\": \"00658000003ceg9AAA\",\n \"Name\": {\n \"value\": \"United Oil Refinery Generators\"\n },\n \"StageName\": {\n \"value\": \"Negotiation/Review\"\n },\n \"CloseDate\": {\n \"value\": \"2023-10-25\",\n \"displayValue\": \"25/10/2023\"\n },\n \"Description\": {\n \"value\": \"This is a sample opportunity.\"\n }\n }\n }\n ]\n }\n }\n }\n },\n \"errors\": []\n}"
}
]
}
