Chilkat Online Tools

lianja / Salesforce Platform APIs / Abort a Job Query

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loJson = createobject("CkJsonObject")
loJson.UpdateString("state","Aborted")

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/jobs/query/{{_jobId}}",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lcId = loJResp.StringOf("id")
lcOperation = loJResp.StringOf("operation")
lcV_object = loJResp.StringOf("object")
lcCreatedById = loJResp.StringOf("createdById")
lcCreatedDate = loJResp.StringOf("createdDate")
lcSystemModstamp = loJResp.StringOf("systemModstamp")
lcState = loJResp.StringOf("state")
lcConcurrencyMode = loJResp.StringOf("concurrencyMode")
lcContentType = loJResp.StringOf("contentType")
lnApiVersion = loJResp.IntOf("apiVersion")


release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp

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