Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "operation": "query",
; "query": "SELECT fields FROM object WHERE filter",
; "contentType": "CSV",
; "columnDelimiter": "BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB",
; "lineEnding": "CRLF | LF"
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("operation","query")
$oJson.UpdateString("query","SELECT fields FROM object WHERE filter")
$oJson.UpdateString("contentType","CSV")
$oJson.UpdateString("columnDelimiter","BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB")
$oJson.UpdateString("lineEnding","CRLF | LF")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/jobs/query","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "750...",
; "operation": "query",
; "object": "Account",
; "createdById": "005...",
; "createdDate": "<datetime>",
; "systemModstamp": "<datetime>",
; "state": "UploadComplete",
; "concurrencyMode": "Parallel",
; "contentType": "CSV",
; "apiVersion": 58,
; "lineEnding": "LF",
; "columnDelimiter": "COMMA"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId = $oJResp.StringOf("id")
Local $sOperation = $oJResp.StringOf("operation")
Local $sV_object = $oJResp.StringOf("object")
Local $sCreatedById = $oJResp.StringOf("createdById")
Local $sCreatedDate = $oJResp.StringOf("createdDate")
Local $systemModstamp = $oJResp.StringOf("systemModstamp")
Local $state = $oJResp.StringOf("state")
Local $sConcurrencyMode = $oJResp.StringOf("concurrencyMode")
Local $sContentType = $oJResp.StringOf("contentType")
Local $iApiVersion = $oJResp.IntOf("apiVersion")
Local $sLineEnding = $oJResp.StringOf("lineEnding")
Local $sColumnDelimiter = $oJResp.StringOf("columnDelimiter")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"operation" : "query",
"query" : "SELECT fields FROM object WHERE filter",
"contentType" : "CSV",
"columnDelimiter" : "BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB",
"lineEnding" : "CRLF | LF"
}'
https://domain.com/services/data/v{{version}}/jobs/query
Postman Collection Item JSON
{
"name": "Successful Create job Query",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
"",
"const response = JSON.parse(pm.response.text())",
"context.set(\"_jobId\", response.id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\" : \"query\",\n \"query\" : \"SELECT fields FROM object WHERE filter\",\n \"contentType\" : \"CSV\",\n \"columnDelimiter\" : \"BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB\",\n \"lineEnding\" : \"CRLF | LF\"\n} "
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"query"
]
}
},
"response": [
{
"name": "Successful Create job Query",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\" : \"query\",\n \"query\" : \"SELECT Id FROM Account\",\n \"contentType\" : \"CSV\",\n \"columnDelimiter\" : \"COMMA\",\n \"lineEnding\" : \"LF\"\n} "
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"query"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:06:06 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=18/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 \"id\": \"750...\",\n \"operation\": \"query\",\n \"object\": \"Account\",\n \"createdById\": \"005...\",\n \"createdDate\": \"<datetime>\",\n \"systemModstamp\": \"<datetime>\",\n \"state\": \"UploadComplete\",\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"apiVersion\": 58,\n \"lineEnding\": \"LF\",\n \"columnDelimiter\": \"COMMA\"\n}"
}
]
}
