Chilkat Online Tools

Java / Salesforce Platform APIs / Abort a Job Query

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "state": "Aborted"
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("state","Aborted");

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

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    json.EmitSb(sbRequestBody);

    CkHttpResponse resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/jobs/query/{{_jobId}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

    // 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": "Aborted",
    //   "concurrencyMode": "Parallel",
    //   "contentType": "CSV",
    //   "apiVersion": 58
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    String id = jResp.stringOf("id");
    String operation = jResp.stringOf("operation");
    String v_object = jResp.stringOf("object");
    String createdById = jResp.stringOf("createdById");
    String createdDate = jResp.stringOf("createdDate");
    String systemModstamp = jResp.stringOf("systemModstamp");
    String state = jResp.stringOf("state");
    String concurrencyMode = jResp.stringOf("concurrencyMode");
    String contentType = jResp.stringOf("contentType");
    int apiVersion = jResp.IntOf("apiVersion");
  }
}

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
	"state":"Aborted"
}'
https://domain.com/services/data/v{{version}}/jobs/query/{{_jobId}}

Postman Collection Item JSON

{
  "name": "Abort a Job Query",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"state\":\"Aborted\"\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query/{{_jobId}}",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "query",
        "{{_jobId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Abort a Job Query",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"state\":\"Aborted\"\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query/{{_jobId}}",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "query",
            "{{_jobId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:10:26 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=29/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "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\": \"Aborted\",\n    \"concurrencyMode\": \"Parallel\",\n    \"contentType\": \"CSV\",\n    \"apiVersion\": 58\n}"
    }
  ]
}