Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_Type
String sV_Url
String sName
Integer iTotalSize
Boolean iDone
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "q" "SELECT name from Account" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/services/data/v{{version}}/queryAll/" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "totalSize": 12,
// "done": true,
// "records": [
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF"
// },
// "Name": "Edge Communications"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF"
// },
// "Name": "Burlington Textiles Corp of America"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF"
// },
// "Name": "Pyramid Construction Inc."
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF"
// },
// "Name": "Dickenson plc"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF"
// },
// "Name": "Grand Hotels & Resorts Ltd"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF"
// },
// "Name": "United Oil & Gas Corp."
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF"
// },
// "Name": "Express Logistics and Transport"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF"
// },
// "Name": "University of Arizona"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF"
// },
// "Name": "United Oil & Gas, UK"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF"
// },
// "Name": "United Oil & Gas, Singapore"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF"
// },
// "Name": "GenePoint"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF"
// },
// "Name": "sForce"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComIntOf Of hoJResp "totalSize" To iTotalSize
Get ComBoolOf Of hoJResp "done" To iDone
Move 0 To i
Get ComSizeOfArray Of hoJResp "records" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "records[i].attributes.type" To sV_Type
Get ComStringOf Of hoJResp "records[i].attributes.url" To sV_Url
Get ComStringOf Of hoJResp "records[i].Name" To sName
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "q=SELECT%20name%20from%20Account"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/queryAll/
Postman Collection Item JSON
{
"name": "QueryAll",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
},
"description": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch. Note that even though nextRecordsUrl has query in the URL, it will still provide remaining results from the initial QueryAll request. The remaining results will include deleted records that matched the initial query.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm"
},
"response": [
{
"name": "QueryAll",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 27 Sep 2023 15:27:21 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Sforce-Limit-Info",
"value": "api-usage=2/15000"
},
{
"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 \"totalSize\": 12,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF\"\n },\n \"Name\": \"Edge Communications\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF\"\n },\n \"Name\": \"Burlington Textiles Corp of America\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF\"\n },\n \"Name\": \"Pyramid Construction Inc.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF\"\n },\n \"Name\": \"Dickenson plc\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF\"\n },\n \"Name\": \"Grand Hotels & Resorts Ltd\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF\"\n },\n \"Name\": \"United Oil & Gas Corp.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF\"\n },\n \"Name\": \"Express Logistics and Transport\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF\"\n },\n \"Name\": \"University of Arizona\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF\"\n },\n \"Name\": \"United Oil & Gas, UK\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF\"\n },\n \"Name\": \"United Oil & Gas, Singapore\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF\"\n },\n \"Name\": \"GenePoint\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF\"\n },\n \"Name\": \"sForce\"\n }\n ]\n}"
}
]
}
