Node.js / Support API / List Targets
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/targets",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)
// {
// "targets": [
// {
// "project_id": "<string>",
// "resource": "<string>",
// "target_url": "<string>",
// "title": "<string>",
// "token": "<string>",
// "type": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "message_id": "<string>",
// "password": "<string>",
// "todo_list_id": "<string>",
// "username": "<string>"
// },
// {
// "project_id": "<string>",
// "resource": "<string>",
// "target_url": "<string>",
// "title": "<string>",
// "token": "<string>",
// "type": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "message_id": "<string>",
// "password": "<string>",
// "todo_list_id": "<string>",
// "username": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var project_id;
var resource;
var target_url;
var title;
var token;
var v_type;
var active;
var created_at;
var id;
var message_id;
var password;
var todo_list_id;
var username;
var i = 0;
var count_i = jResp.SizeOfArray("targets");
while (i < count_i) {
jResp.I = i;
project_id = jResp.StringOf("targets[i].project_id");
resource = jResp.StringOf("targets[i].resource");
target_url = jResp.StringOf("targets[i].target_url");
title = jResp.StringOf("targets[i].title");
token = jResp.StringOf("targets[i].token");
v_type = jResp.StringOf("targets[i].type");
active = jResp.StringOf("targets[i].active");
created_at = jResp.StringOf("targets[i].created_at");
id = jResp.StringOf("targets[i].id");
message_id = jResp.StringOf("targets[i].message_id");
password = jResp.StringOf("targets[i].password");
todo_list_id = jResp.StringOf("targets[i].todo_list_id");
username = jResp.StringOf("targets[i].username");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/targets
Postman Collection Item JSON
{
"name": "List Targets",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
},
"description": "#### 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/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"targets\": [\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n },\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n }\n ]\n}"
}
]
}