Chilkat Online Tools

VB.NET / Salesforce Platform APIs / Successful Create job Query

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' 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"
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("operation","query")
json.UpdateString("query","SELECT fields FROM object WHERE filter")
json.UpdateString("contentType","CSV")
json.UpdateString("columnDelimiter","BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB")
json.UpdateString("lineEnding","CRLF | LF")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/services/data/v{{version}}/jobs/query","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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




Dim id As String = jResp.StringOf("id")
Dim operation As String = jResp.StringOf("operation")
Dim v_object As String = jResp.StringOf("object")
Dim createdById As String = jResp.StringOf("createdById")
Dim createdDate As String = jResp.StringOf("createdDate")
Dim systemModstamp As String = jResp.StringOf("systemModstamp")
Dim state As String = jResp.StringOf("state")
Dim concurrencyMode As String = jResp.StringOf("concurrencyMode")
Dim contentType As String = jResp.StringOf("contentType")
Dim apiVersion As Integer = jResp.IntOf("apiVersion")
Dim lineEnding As String = jResp.StringOf("lineEnding")
Dim columnDelimiter As String = jResp.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}"
    }
  ]
}