TCL / Support API / Show Ticket Field Option
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/ticket_fields/:ticket_field_id/options/:ticket_field_option_id" $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)
# {
# "custom_field_option": {
# "name": "<string>",
# "value": "<string>",
# "id": "<integer>",
# "position": "<integer>",
# "raw_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 Name [CkJsonObject_stringOf $jResp "custom_field_option.name"]
set Value [CkJsonObject_stringOf $jResp "custom_field_option.value"]
set Id [CkJsonObject_stringOf $jResp "custom_field_option.id"]
set Position [CkJsonObject_stringOf $jResp "custom_field_option.position"]
set Raw_name [CkJsonObject_stringOf $jResp "custom_field_option.raw_name"]
set v_Url [CkJsonObject_stringOf $jResp "custom_field_option.url"]
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/ticket_fields/:ticket_field_id/options/:ticket_field_option_id
Postman Collection Item JSON
{
"name": "Show Ticket Field Option",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_fields/:ticket_field_id/options/:ticket_field_option_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields",
":ticket_field_id",
"options",
":ticket_field_option_id"
],
"variable": [
{
"key": "ticket_field_id",
"value": "<integer>"
},
{
"key": "ticket_field_option_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed for\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/ticket_fields/:ticket_field_id/options/:ticket_field_option_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields",
":ticket_field_id",
"options",
":ticket_field_option_id"
],
"variable": [
{
"key": "ticket_field_id"
},
{
"key": "ticket_field_option_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_field_option\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}