Chilkat Online Tools

delphiAx / Salesforce Platform APIs / Successful Create job Query

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
operation: WideString;
v_object: WideString;
createdById: WideString;
createdDate: WideString;
systemModstamp: WideString;
state: WideString;
concurrencyMode: WideString;
contentType: WideString;
apiVersion: Integer;
lineEnding: WideString;
columnDelimiter: WideString;

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

http := TChilkatHttp.Create(Self);

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

json := TChilkatJsonObject.Create(Self);
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');

resp := http.PostJson3('https://domain.com/services/data/v{{version}}/jobs/query','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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

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