Objective-C / Salesforce Platform APIs / Accounts with Cursors (Pagination)
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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}"
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"query" value: @"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}"];
[json UpdateString: @"variables" value: @"{\n \"first\": 3,\n \"after\": null\n}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"X-Chatter-Entity-Encoding" value: @"false"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/services/data/v{{version}}/graphql" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *Id = 0;
NSString *Value = 0;
int TotalCount = [[jResp IntOf: @"data.uiapi.query.Account.totalCount"] intValue];
BOOL HasNextPage = [jResp BoolOf: @"data.uiapi.query.Account.pageInfo.hasNextPage"];
BOOL HasPreviousPage = [jResp BoolOf: @"data.uiapi.query.Account.pageInfo.hasPreviousPage"];
NSString *StartCursor = [jResp StringOf: @"data.uiapi.query.Account.pageInfo.startCursor"];
NSString *EndCursor = [jResp StringOf: @"data.uiapi.query.Account.pageInfo.endCursor"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data.uiapi.query.Account.edges"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
i = 0;
count_i = [[jResp SizeOfArray: @"errors"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
i = i + 1;
}
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}"
}
]
}
