Chilkat Online Tools

VB.NET / Salesforce Platform APIs / Accounts with Cursors (Pagination)

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' 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}"
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("query","query accountsWithCursors($first: Int, $after: String) {" & vbLf & "  uiapi {" & vbLf & "    query {" & vbLf & "      Account(first: $first, after: $after) {" & vbLf & "        edges {" & vbLf & "          node {" & vbLf & "            Id" & vbLf & "            Name {" & vbLf & "              value" & vbLf & "            }" & vbLf & "          }" & vbLf & "        }" & vbLf & "        totalCount" & vbLf & "        pageInfo {" & vbLf & "          hasNextPage" & vbLf & "          hasPreviousPage" & vbLf & "          startCursor" & vbLf & "          endCursor" & vbLf & "        }" & vbLf & "      }" & vbLf & "    }" & vbLf & "  }" & vbLf & "}")
json.UpdateString("variables","{" & vbLf & "    ""first"": 3," & vbLf & "    ""after"": null" & vbLf & "}")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("X-Chatter-Entity-Encoding","false")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



Dim Id As String
Dim Value As String

Dim TotalCount As Integer = jResp.IntOf("data.uiapi.query.Account.totalCount")
Dim HasNextPage As Boolean = jResp.BoolOf("data.uiapi.query.Account.pageInfo.hasNextPage")
Dim HasPreviousPage As Boolean = jResp.BoolOf("data.uiapi.query.Account.pageInfo.hasPreviousPage")
Dim StartCursor As String = jResp.StringOf("data.uiapi.query.Account.pageInfo.startCursor")
Dim EndCursor As String = jResp.StringOf("data.uiapi.query.Account.pageInfo.endCursor")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data.uiapi.query.Account.edges")
While i < count_i
    jResp.I = i
    Id = jResp.StringOf("data.uiapi.query.Account.edges[i].node.Id")
    Value = jResp.StringOf("data.uiapi.query.Account.edges[i].node.Name.value")
    i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("errors")
While i < count_i
    jResp.I = i
    i = i + 1
End While

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}"
    }
  ]
}