TCL / Support API / List Target Failures
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/target_failures" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "target_failures"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set consecutive_failure_count [CkJsonObject_stringOf $jResp "target_failures[i].consecutive_failure_count"]
set created_at [CkJsonObject_stringOf $jResp "target_failures[i].created_at"]
set id [CkJsonObject_stringOf $jResp "target_failures[i].id"]
set raw_request [CkJsonObject_stringOf $jResp "target_failures[i].raw_request"]
set raw_response [CkJsonObject_stringOf $jResp "target_failures[i].raw_response"]
set status_code [CkJsonObject_stringOf $jResp "target_failures[i].status_code"]
set target_name [CkJsonObject_stringOf $jResp "target_failures[i].target_name"]
set url [CkJsonObject_stringOf $jResp "target_failures[i].url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}