Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcValue
LOCAL lnTotalCount
LOCAL lnHasNextPage
LOCAL lnHasPreviousPage
LOCAL lcStartCursor
LOCAL lcEndCursor
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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}"
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
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 = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
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")
lnHasNextPage = loJResp.BoolOf("data.uiapi.query.Account.pageInfo.hasNextPage")
lnHasPreviousPage = 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}"
}
]
}
