Chilkat Online Tools

.NET Core C# / Salesforce Platform APIs / Close or Abort a Job

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool 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": "UploadComplete"
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("state","UploadComplete");

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

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

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

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "750...",
//   "operation": "insert",
//   "object": "Account",
//   "createdById": "005...",
//   "createdDate": "<datetime>",
//   "systemModstamp": "<datetime>",
//   "state": "UploadComplete",
//   "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":"UploadComplete"
}'
https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}

Postman Collection Item JSON

{
  "name": "Close or Abort a Job",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"state\":\"UploadComplete\"\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "ingest",
        "{{_jobId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Close or Abort a Job",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"state\":\"UploadComplete\"\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "ingest",
            "{{_jobId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:00:44 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=2/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"id\": \"750...\",\n    \"operation\": \"insert\",\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}"
    }
  ]
}