Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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 contactsByTheirAccountName {\n uiapi {\n query {\n Contact(orderBy: { Account: { Name: { order: DESC } } }) {\n edges {\n node {\n Id\n Name {\n value\n }\n Account {\n Name {\n value\n }\n }\n }\n }\n }\n }\n }\n}",
; "variables": ""
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("query","query contactsByTheirAccountName {" & @LF & " uiapi {" & @LF & " query {" & @LF & " Contact(orderBy: { Account: { Name: { order: DESC } } }) {" & @LF & " edges {" & @LF & " node {" & @LF & " Id" & @LF & " Name {" & @LF & " value" & @LF & " }" & @LF & " Account {" & @LF & " Name {" & @LF & " value" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & "}")
$oJson.UpdateString("variables","")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "X-Chatter-Entity-Encoding","false"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "uiapi": {
; "query": {
; "Contact": {
; "edges": [
; {
; "node": {
; "Id": "00358000006c0mzAAA",
; "Name": {
; "value": "Julia Wilds"
; },
; "Account": {
; "Name": {
; "value": "University of Arizona"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006woy5AAA",
; "Name": {
; "value": "Jane Grey"
; },
; "Account": {
; "Name": {
; "value": "University of Arizona"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006c0n6AAA",
; "Name": {
; "value": "Basil Wenceslas"
; },
; "Account": {
; "Name": {
; "value": "University of Arizona"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006c0kdAAA",
; "Name": {
; "value": "John Dodge"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas, Singapore"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006woy9AAA",
; "Name": {
; "value": "Liz D'Cruz"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas, Singapore"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006woy8AAA",
; "Name": {
; "value": "Tom Ripley"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas, Singapore"
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006c0kfAAA",
; "Name": {
; "value": "George Dapper"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas Corp."
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006woy1AAA",
; "Name": {
; "value": "Stella Pavlova"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas Corp."
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006woyBAAQ",
; "Name": {
; "value": "Avi Green"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas Corp."
; }
; }
; }
; },
; {
; "node": {
; "Id": "00358000006c0mxAAA",
; "Name": {
; "value": "Winter Drake"
; },
; "Account": {
; "Name": {
; "value": "United Oil & Gas Corp."
; }
; }
; }
; }
; ]
; }
; }
; }
; },
; "errors": [
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId
Local $sValue
Local $sNameValue
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.uiapi.query.Contact.edges")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.uiapi.query.Contact.edges[i].node.Id")
$sValue = $oJResp.StringOf("data.uiapi.query.Contact.edges[i].node.Name.value")
$sNameValue = $oJResp.StringOf("data.uiapi.query.Contact.edges[i].node.Account.Name.value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("errors")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-Chatter-Entity-Encoding: false"
--data-raw '{"query":"query contactsByTheirAccountName {\n uiapi {\n query {\n Contact(orderBy: { Account: { Name: { order: DESC } } }) {\n edges {\n node {\n Id\n Name {\n value\n }\n Account {\n Name {\n value\n }\n }\n }\n }\n }\n }\n }\n}","variables":""}'
https://domain.com/services/data/v{{version}}/graphql
Postman Collection Item JSON
{
"name": "Contacts with Account Name",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query contactsByTheirAccountName {\n uiapi {\n query {\n Contact(orderBy: { Account: { Name: { order: DESC } } }) {\n edges {\n node {\n Id\n Name {\n value\n }\n Account {\n Name {\n value\n }\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": "Contacts with Account Name",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query contactsByTheirAccountName {\n uiapi {\n query {\n Contact(orderBy: { Account: { Name: { order: DESC } } }) {\n edges {\n node {\n Id\n Name {\n value\n }\n Account {\n Name {\n value\n }\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:12:09 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 \"Contact\": {\n \"edges\": [\n {\n \"node\": {\n \"Id\": \"00358000006c0mzAAA\",\n \"Name\": {\n \"value\": \"Julia Wilds\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"University of Arizona\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006woy5AAA\",\n \"Name\": {\n \"value\": \"Jane Grey\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"University of Arizona\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006c0n6AAA\",\n \"Name\": {\n \"value\": \"Basil Wenceslas\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"University of Arizona\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006c0kdAAA\",\n \"Name\": {\n \"value\": \"John Dodge\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas, Singapore\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006woy9AAA\",\n \"Name\": {\n \"value\": \"Liz D'Cruz\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas, Singapore\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006woy8AAA\",\n \"Name\": {\n \"value\": \"Tom Ripley\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas, Singapore\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006c0kfAAA\",\n \"Name\": {\n \"value\": \"George Dapper\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas Corp.\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006woy1AAA\",\n \"Name\": {\n \"value\": \"Stella Pavlova\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas Corp.\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006woyBAAQ\",\n \"Name\": {\n \"value\": \"Avi Green\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas Corp.\"\n }\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"00358000006c0mxAAA\",\n \"Name\": {\n \"value\": \"Winter Drake\"\n },\n \"Account\": {\n \"Name\": {\n \"value\": \"United Oil & Gas Corp.\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"errors\": []\n}"
}
]
}
