Chilkat Online Tools

lianja / 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.

loHttp = createobject("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}"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("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) + "}")
loJson.UpdateString("variables",'{' + Chr(10) + '    "first": 3,' + Chr(10) + '    "after": null' + Chr(10) + '}')

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

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lnTotalCount = loJResp.IntOf("data.uiapi.query.Account.totalCount")
llHasNextPage = loJResp.BoolOf("data.uiapi.query.Account.pageInfo.hasNextPage")
llHasPreviousPage = loJResp.BoolOf("data.uiapi.query.Account.pageInfo.hasPreviousPage")
lcStartCursor = loJResp.StringOf("data.uiapi.query.Account.pageInfo.startCursor")
lcEndCursor = loJResp.StringOf("data.uiapi.query.Account.pageInfo.endCursor")
i = 0
lnCount_i = loJResp.SizeOfArray("data.uiapi.query.Account.edges")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.uiapi.query.Account.edges[i].node.Id")
    lcValue = loJResp.StringOf("data.uiapi.query.Account.edges[i].node.Name.value")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp

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