Chilkat Online Tools

TCL / Salesforce Platform APIs / Accounts with Cursors (Pagination)

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "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}"
CkJsonObject_UpdateString $json "variables" "{\n    \"first\": 3,\n    \"after\": null\n}"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-Chatter-Entity-Encoding" "false"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/services/data/v{{version}}/graphql" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $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

set TotalCount [CkJsonObject_IntOf $jResp "data.uiapi.query.Account.totalCount"]
set HasNextPage [CkJsonObject_BoolOf $jResp "data.uiapi.query.Account.pageInfo.hasNextPage"]
set HasPreviousPage [CkJsonObject_BoolOf $jResp "data.uiapi.query.Account.pageInfo.hasPreviousPage"]
set StartCursor [CkJsonObject_stringOf $jResp "data.uiapi.query.Account.pageInfo.startCursor"]
set EndCursor [CkJsonObject_stringOf $jResp "data.uiapi.query.Account.pageInfo.endCursor"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.uiapi.query.Account.edges"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Id [CkJsonObject_stringOf $jResp "data.uiapi.query.Account.edges[i].node.Id"]
    set Value [CkJsonObject_stringOf $jResp "data.uiapi.query.Account.edges[i].node.Name.value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "errors"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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