Chilkat Online Tools

Node.js / Support API / List Target Failures

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";

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/target_failures",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

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

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

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "target_failures": [
    //     {
    //       "consecutive_failure_count": "<integer>",
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "raw_request": "<string>",
    //       "raw_response": "<string>",
    //       "status_code": "<integer>",
    //       "target_name": "<string>",
    //       "url": "<string>"
    //     },
    //     {
    //       "consecutive_failure_count": "<integer>",
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "raw_request": "<string>",
    //       "raw_response": "<string>",
    //       "status_code": "<integer>",
    //       "target_name": "<string>",
    //       "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 consecutive_failure_count;
    var created_at;
    var id;
    var raw_request;
    var raw_response;
    var status_code;
    var target_name;
    var url;

    var i = 0;
    var count_i = jResp.SizeOfArray("target_failures");
    while (i < count_i) {
        jResp.I = i;
        consecutive_failure_count = jResp.StringOf("target_failures[i].consecutive_failure_count");
        created_at = jResp.StringOf("target_failures[i].created_at");
        id = jResp.StringOf("target_failures[i].id");
        raw_request = jResp.StringOf("target_failures[i].raw_request");
        raw_response = jResp.StringOf("target_failures[i].raw_response");
        status_code = jResp.StringOf("target_failures[i].status_code");
        target_name = jResp.StringOf("target_failures[i].target_name");
        url = jResp.StringOf("target_failures[i].url");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/target_failures

Postman Collection Item JSON

{
  "name": "List Target Failures",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/target_failures",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "target_failures"
      ]
    },
    "description": "Returns the 25 most recent target failures, per target.\n\n#### Stability\n\n* Development\n\n#### Allowed For\n\n* Admins\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/target_failures",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "target_failures"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target_failures\": [\n    {\n      \"consecutive_failure_count\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"raw_request\": \"<string>\",\n      \"raw_response\": \"<string>\",\n      \"status_code\": \"<integer>\",\n      \"target_name\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"consecutive_failure_count\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"raw_request\": \"<string>\",\n      \"raw_response\": \"<string>\",\n      \"status_code\": \"<integer>\",\n      \"target_name\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}