TCL / Support API / Ticket Related Information
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/tickets/:ticket_id/related" $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)
# {
# "followup_source_ids": [
# "<string>",
# "<string>"
# ],
# "from_archive": "<boolean>",
# "incidents": "<integer>",
# "topic_id": "<string>",
# "twitter": {
# "dolor__1": 77550121,
# "commodo4b": true
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set from_archive [CkJsonObject_stringOf $jResp "from_archive"]
set incidents [CkJsonObject_stringOf $jResp "incidents"]
set topic_id [CkJsonObject_stringOf $jResp "topic_id"]
set Dolor__1 [CkJsonObject_IntOf $jResp "twitter.dolor__1"]
set Commodo4b [CkJsonObject_BoolOf $jResp "twitter.commodo4b"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "followup_source_ids"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "followup_source_ids[i]"]
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/tickets/:ticket_id/related
Postman Collection Item JSON
{
"name": "Ticket Related Information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/related",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"related"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "The request returns a data object with the following properties:\n\n| Name | Type | Comment\n| ------------------- | ------- | -------\n| topic_id | string | Related topic in the Web portal (deprecated feature)\n| followup_source_ids | array | Sources to follow up\n| from_archive | boolean | Is true if the current ticket is archived\n| incidents | integer | A count of related incident occurrences\n| twitter | object | Twitter information associated with the ticket\n\n#### Allowed For\n\n* Agents"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/related",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"related"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"followup_source_ids\": [\n \"<string>\",\n \"<string>\"\n ],\n \"from_archive\": \"<boolean>\",\n \"incidents\": \"<integer>\",\n \"topic_id\": \"<string>\",\n \"twitter\": {\n \"dolor__1\": 77550121,\n \"commodo4b\": true\n }\n}"
}
]
}