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 accountsWithCursors($first: Int, $after: String) {\n uiapi {\n query {\n Account(first: $first, after: $after) {\n edges {\n node {\n Id\n Name {\n value\n }\n }\n }\n totalCount\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n }\n }\n }\n}",
; "variables": "{\n \"first\": 3,\n \"after\": null\n}"
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("query","query accountsWithCursors($first: Int, $after: String) {" & @LF & " uiapi {" & @LF & " query {" & @LF & " Account(first: $first, after: $after) {" & @LF & " edges {" & @LF & " node {" & @LF & " Id" & @LF & " Name {" & @LF & " value" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " totalCount" & @LF & " pageInfo {" & @LF & " hasNextPage" & @LF & " hasPreviousPage" & @LF & " startCursor" & @LF & " endCursor" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & " }" & @LF & "}")
$oJson.UpdateString("variables","{" & @LF & " ""first"": 3," & @LF & " ""after"": null" & @LF & "}")
; 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": {
; "Account": {
; "edges": [
; {
; "node": {
; "Id": "0014H00004CXfY8QAL",
; "Name": {
; "value": "An Account"
; }
; }
; },
; {
; "node": {
; "Id": "0014H00002E6wi6QAB",
; "Name": {
; "value": "Sample Account"
; }
; }
; },
; {
; "node": {
; "Id": "0014H00002x6HUhQAM",
; "Name": {
; "value": "ACME Inc."
; }
; }
; }
; ],
; "totalCount": 524,
; "pageInfo": {
; "hasNextPage": true,
; "hasPreviousPage": false,
; "startCursor": "djE6MA==",
; "endCursor": "djE6Mg=="
; }
; }
; }
; }
; },
; "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 $iTotalCount = $oJResp.IntOf("data.uiapi.query.Account.totalCount")
Local $bHasNextPage = $oJResp.BoolOf("data.uiapi.query.Account.pageInfo.hasNextPage")
Local $bHasPreviousPage = $oJResp.BoolOf("data.uiapi.query.Account.pageInfo.hasPreviousPage")
Local $sStartCursor = $oJResp.StringOf("data.uiapi.query.Account.pageInfo.startCursor")
Local $sEndCursor = $oJResp.StringOf("data.uiapi.query.Account.pageInfo.endCursor")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.uiapi.query.Account.edges")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.uiapi.query.Account.edges[i].node.Id")
$sValue = $oJResp.StringOf("data.uiapi.query.Account.edges[i].node.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 accountsWithCursors($first: Int, $after: String) {\n uiapi {\n query {\n Account(first: $first, after: $after) {\n edges {\n node {\n Id\n Name {\n value\n }\n }\n }\n totalCount\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n }\n }\n }\n}","variables":"{\n \"first\": 3,\n \"after\": null\n}"}'
https://domain.com/services/data/v{{version}}/graphql
Postman Collection Item JSON
{
"name": "Accounts with Cursors (Pagination)",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query accountsWithCursors($first: Int, $after: String) {\n uiapi {\n query {\n Account(first: $first, after: $after) {\n edges {\n node {\n Id\n Name {\n value\n }\n }\n }\n totalCount\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n }\n }\n }\n}",
"variables": "{\n \"first\": 3,\n \"after\": null\n}"
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"graphql"
]
}
},
"response": [
{
"name": "Accounts with Cursors (Pagination)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query accountsWithCursors($first: Int, $after: String) {\n uiapi {\n query {\n Account(first: $first, after: $after) {\n edges {\n node {\n Id\n Name {\n value\n }\n }\n }\n totalCount\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n }\n }\n }\n}",
"variables": "{\n \"first\": 3,\n \"after\": null\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:05:20 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 \"Account\": {\n \"edges\": [\n {\n \"node\": {\n \"Id\": \"0014H00004CXfY8QAL\",\n \"Name\": {\n \"value\": \"An Account\"\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"0014H00002E6wi6QAB\",\n \"Name\": {\n \"value\": \"Sample Account\"\n }\n }\n },\n {\n \"node\": {\n \"Id\": \"0014H00002x6HUhQAM\",\n \"Name\": {\n \"value\": \"ACME Inc.\"\n }\n }\n }\n ],\n \"totalCount\": 524,\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": false,\n \"startCursor\": \"djE6MA==\",\n \"endCursor\": \"djE6Mg==\"\n }\n }\n }\n }\n },\n \"errors\": []\n}"
}
]
}
