Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Operation
string ls_V_object
string ls_CreatedById
string ls_CreatedDate
string ls_SystemModstamp
string ls_State
string ls_ConcurrencyMode
string ls_ContentType
integer li_ApiVersion
string ls_LineEnding
string ls_ColumnDelimiter
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("operation","query")
loo_Json.UpdateString("query","SELECT fields FROM object WHERE filter")
loo_Json.UpdateString("contentType","CSV")
loo_Json.UpdateString("columnDelimiter","BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB")
loo_Json.UpdateString("lineEnding","CRLF | LF")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://domain.com/services/data/v{{version}}/jobs/query","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Id = loo_JResp.StringOf("id")
ls_Operation = loo_JResp.StringOf("operation")
ls_V_object = loo_JResp.StringOf("object")
ls_CreatedById = loo_JResp.StringOf("createdById")
ls_CreatedDate = loo_JResp.StringOf("createdDate")
ls_SystemModstamp = loo_JResp.StringOf("systemModstamp")
ls_State = loo_JResp.StringOf("state")
ls_ConcurrencyMode = loo_JResp.StringOf("concurrencyMode")
ls_ContentType = loo_JResp.StringOf("contentType")
li_ApiVersion = loo_JResp.IntOf("apiVersion")
ls_LineEnding = loo_JResp.StringOf("lineEnding")
ls_ColumnDelimiter = loo_JResp.StringOf("columnDelimiter")
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
