PureBasic / Salesforce Platform APIs / Accounts with Cursors (Pagination)
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 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}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"query","query accountsWithCursors($first: Int, $after: String) {" + Chr(10) + " uiapi {" + Chr(10) + " query {" + Chr(10) + " Account(first: $first, after: $after) {" + Chr(10) + " edges {" + Chr(10) + " node {" + Chr(10) + " Id" + Chr(10) + " Name {" + Chr(10) + " value" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " totalCount" + Chr(10) + " pageInfo {" + Chr(10) + " hasNextPage" + Chr(10) + " hasPreviousPage" + Chr(10) + " startCursor" + Chr(10) + " endCursor" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + " }" + Chr(10) + "}")
CkJsonObject::ckUpdateString(json,"variables","{" + Chr(10) + " " + Chr(34) + "first" + Chr(34) + ": 3," + Chr(10) + " " + Chr(34) + "after" + Chr(34) + ": null" + Chr(10) + "}")
; 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": {
; "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
Id.s
Value.s
TotalCount.i = CkJsonObject::ckIntOf(jResp,"data.uiapi.query.Account.totalCount")
HasNextPage.i = CkJsonObject::ckBoolOf(jResp,"data.uiapi.query.Account.pageInfo.hasNextPage")
HasPreviousPage.i = CkJsonObject::ckBoolOf(jResp,"data.uiapi.query.Account.pageInfo.hasPreviousPage")
StartCursor.s = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Account.pageInfo.startCursor")
EndCursor.s = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Account.pageInfo.endCursor")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.uiapi.query.Account.edges")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Id = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Account.edges[i].node.Id")
Value = CkJsonObject::ckStringOf(jResp,"data.uiapi.query.Account.edges[i].node.Name.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 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}"
}
]
}
