Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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 opportunitiesClosed {\n uiapi {\n query {\n Opportunity(\n where: {\n or: [\n { StageName: { eq: \"Prospecting\" } }\n { StageName: { eq: \"Needs Analysis\" } }\n ]\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n StageName {\n value\n }\n }\n }\n }\n }\n }\n}",
; "variables": ""
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"query","query opportunitiesClosed {" + Chr(10) + " uiapi {" + Chr(10) + " query {" + Chr(10) + " Opportunity(" + Chr(10) + " where: {" + Chr(10) + " or: [" + Chr(10) + " { StageName: { eq: " + Chr(34) + "Prospecting" + Chr(34) + " } }" + Chr(10) + " { StageName: { eq: " + Chr(34) + "Needs Analysis" + Chr(34) + " } }" + Chr(10) + " ]" + Chr(10) + " }" + Chr(10) + " ) {" + Chr(10) + " edges {" + Chr(10) + " node {" + Chr(10) + " Id" + Chr(10) + " Name {" + Chr(10) + " value" + Chr(10) + " }" + Chr(10) + " CloseDate {" + Chr(10) + " value" + Chr(10) + " displayValue" + Chr(10) + " }" + Chr(10) + " Description {" + Chr(10) + " value" + Chr(10) + " }" + Chr(10) + " StageName {" + Chr(10) + " value" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + "}")
CkJsonObject::ckUpdateString(json,"variables","")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"X-Chatter-Entity-Encoding","false")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/graphql","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "uiapi": {
; "query": {
; "Opportunity": {
; "edges": [
; {
; "node": {
; "Id": "00658000003cegEAAQ",
; "Name": {
; "value": "Pyramid Emergency Generators"
; },
; "CloseDate": {
; "value": "2014-04-19",
; "displayValue": "19/04/2014"
; },
; "Description": {
; "value": "This is a sample description"
; },
; "StageName": {
; "value": "Prospecting"
; }
; }
; },
; {
; "node": {
; "Id": "00658000003cegXAAQ",
; "Name": {
; "value": "United Oil Plant Standby Generators"
; },
; "CloseDate": {
; "value": "2014-04-19",
; "displayValue": "19/04/2014"
; },
; "Description": {
; "value": "00658000003cegXAAQ"
; },
; "StageName": {
; "value": "Needs Analysis"
; }
; }
; }
; ]
; }
; }
; }
; },
; "errors": [
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id.s
Value.s
CloseDateValue.s
DisplayValue.s
DescriptionValue.s
StageNameValue.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.uiapi.query.Opportunity.edges")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Id = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.Id")
Value = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.Name.value")
CloseDateValue = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.CloseDate.value")
DisplayValue = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.CloseDate.displayValue")
DescriptionValue = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.Description.value")
StageNameValue = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Opportunity.edges[i].node.StageName.value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"errors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-Chatter-Entity-Encoding: false"
--data-raw '{"query":"query opportunitiesClosed {\n uiapi {\n query {\n Opportunity(\n where: {\n or: [\n { StageName: { eq: \"Prospecting\" } }\n { StageName: { eq: \"Needs Analysis\" } }\n ]\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n StageName {\n value\n }\n }\n }\n }\n }\n }\n}","variables":""}'
https://domain.com/services/data/v{{version}}/graphql
Postman Collection Item JSON
{
"name": "Opportunities Early Stage",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosed {\n uiapi {\n query {\n Opportunity(\n where: {\n or: [\n { StageName: { eq: \"Prospecting\" } }\n { StageName: { eq: \"Needs Analysis\" } }\n ]\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n StageName {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": ""
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"graphql"
]
}
},
"response": [
{
"name": "Opportunities Early Stage",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosed {\n uiapi {\n query {\n Opportunity(\n where: {\n or: [\n { StageName: { eq: \"Prospecting\" } }\n { StageName: { eq: \"Needs Analysis\" } }\n ]\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n StageName {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": ""
}
},
"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:22:21 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\": \"00658000003cegEAAQ\",\n \"Name\": {\n \"value\": \"Pyramid Emergency Generators\"\n },\n \"CloseDate\": {\n \"value\": \"2014-04-19\",\n \"displayValue\": \"19/04/2014\"\n },\n \"Description\": {\n \"value\": \"This is a sample description\"\n },\n \"StageName\": {\n \"value\": \"Prospecting\"\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00658000003cegXAAQ\",\n \"Name\": {\n \"value\": \"United Oil Plant Standby Generators\"\n },\n \"CloseDate\": {\n \"value\": \"2014-04-19\",\n \"displayValue\": \"19/04/2014\"\n },\n \"Description\": {\n \"value\": \"00658000003cegXAAQ\"\n },\n \"StageName\": {\n \"value\": \"Needs Analysis\"\n }\n }\n }\n ]\n }\n }\n }\n },\n \"errors\": []\n}"
}
]
}
