Chilkat Online Tools

Node.js / Support API / Show Many Job Statuses

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("ids","<string>");

    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/job_statuses/show_many",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

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

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    // {
    //   "job_statuses": [
    //     {
    //       "id": "<string>",
    //       "message": "<string>",
    //       "progress": "<integer>",
    //       "results": [
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         }
    //       ],
    //       "status": "<string>",
    //       "total": "<integer>",
    //       "url": "<string>"
    //     },
    //     {
    //       "id": "<string>",
    //       "message": "<string>",
    //       "progress": "<integer>",
    //       "results": [
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         }
    //       ],
    //       "status": "<string>",
    //       "total": "<integer>",
    //       "url": "<string>"
    //     }
    //   ]
    // }

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

    var id;
    var message;
    var progress;
    var status;
    var total;
    var url;
    var j;
    var count_j;
    var index;

    var i = 0;
    var count_i = jResp.SizeOfArray("job_statuses");
    while (i < count_i) {
        jResp.I = i;
        id = jResp.StringOf("job_statuses[i].id");
        message = jResp.StringOf("job_statuses[i].message");
        progress = jResp.StringOf("job_statuses[i].progress");
        status = jResp.StringOf("job_statuses[i].status");
        total = jResp.StringOf("job_statuses[i].total");
        url = jResp.StringOf("job_statuses[i].url");
        j = 0;
        count_j = jResp.SizeOfArray("job_statuses[i].results");
        while (j < count_j) {
            jResp.J = j;
            id = jResp.StringOf("job_statuses[i].results[j].id");
            index = jResp.StringOf("job_statuses[i].results[j].index");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses/show_many

Postman Collection Item JSON

{
  "name": "Show Many Job Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses/show_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Comma-separated list of job status ids."
        }
      ]
    },
    "description": "Accepts a comma-separated list of job status ids.\n\n#### Allowed For:\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success Response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/job_statuses/show_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Comma-separated list of job status ids."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_statuses\": [\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}