Chilkat Tools

TCL / Support API / Show Ticket

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" $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)

# {
#   "ticket": {
#     "requester_id": "<integer>",
#     "allow_attachments": "<boolean>",
#     "allow_channelback": "<boolean>",
#     "assignee_email": "<string>",
#     "assignee_id": "<integer>",
#     "attribute_value_ids": "<array>",
#     "brand_id": "<integer>",
#     "collaborator_ids": "<array>",
#     "collaborators": [
#       {
#         "email": "<email>",
#         "name": "<string>"
#       },
#       {
#         "email": "<email>",
#         "name": "<string>"
#       }
#     ],
#     "comment": {},
#     "created_at": "<dateTime>",
#     "custom_fields": "<array>",
#     "custom_status_id": "<integer>",
#     "description": "<string>",
#     "due_at": "<dateTime>",
#     "email_cc_ids": "<array>",
#     "email_ccs": {},
#     "external_id": "<string>",
#     "follower_ids": "<array>",
#     "followers": {},
#     "followup_ids": "<array>",
#     "forum_topic_id": "<integer>",
#     "from_messaging_channel": "<boolean>",
#     "group_id": "<integer>",
#     "has_incidents": "<boolean>",
#     "id": "<integer>",
#     "is_public": "<boolean>",
#     "macro_id": "<integer>",
#     "macro_ids": "<array>",
#     "metadata": {},
#     "organization_id": "<integer>",
#     "priority": "normal",
#     "problem_id": "<integer>",
#     "raw_subject": "<string>",
#     "recipient": "<string>",
#     "requester": {},
#     "safe_update": "<boolean>",
#     "satisfaction_rating": {
#       "in_11": -9796534.714120895
#     },
#     "sharing_agreement_ids": "<array>",
#     "status": "hold",
#     "subject": "<string>",
#     "submitter_id": "<integer>",
#     "tags": "<array>",
#     "ticket_form_id": "<integer>",
#     "type": "question",
#     "updated_at": "<dateTime>",
#     "updated_stamp": "<string>",
#     "url": "<string>",
#     "via": {
#       "channel": "<string>",
#       "source": {
#         "Ut__a": -44750185.46031158,
#         "dolored2b": 8252599,
#         "mollit1a6": true
#       }
#     },
#     "via_followup_source_id": "<integer>",
#     "via_id": "<integer>",
#     "voice_comment": {}
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Requester_id [CkJsonObject_stringOf $jResp "ticket.requester_id"]
set Allow_attachments [CkJsonObject_stringOf $jResp "ticket.allow_attachments"]
set Allow_channelback [CkJsonObject_stringOf $jResp "ticket.allow_channelback"]
set Assignee_email [CkJsonObject_stringOf $jResp "ticket.assignee_email"]
set Assignee_id [CkJsonObject_stringOf $jResp "ticket.assignee_id"]
set Attribute_value_ids [CkJsonObject_stringOf $jResp "ticket.attribute_value_ids"]
set Brand_id [CkJsonObject_stringOf $jResp "ticket.brand_id"]
set Collaborator_ids [CkJsonObject_stringOf $jResp "ticket.collaborator_ids"]
set Created_at [CkJsonObject_stringOf $jResp "ticket.created_at"]
set Custom_fields [CkJsonObject_stringOf $jResp "ticket.custom_fields"]
set Custom_status_id [CkJsonObject_stringOf $jResp "ticket.custom_status_id"]
set Description [CkJsonObject_stringOf $jResp "ticket.description"]
set Due_at [CkJsonObject_stringOf $jResp "ticket.due_at"]
set Email_cc_ids [CkJsonObject_stringOf $jResp "ticket.email_cc_ids"]
set External_id [CkJsonObject_stringOf $jResp "ticket.external_id"]
set Follower_ids [CkJsonObject_stringOf $jResp "ticket.follower_ids"]
set Followup_ids [CkJsonObject_stringOf $jResp "ticket.followup_ids"]
set Forum_topic_id [CkJsonObject_stringOf $jResp "ticket.forum_topic_id"]
set From_messaging_channel [CkJsonObject_stringOf $jResp "ticket.from_messaging_channel"]
set Group_id [CkJsonObject_stringOf $jResp "ticket.group_id"]
set Has_incidents [CkJsonObject_stringOf $jResp "ticket.has_incidents"]
set Id [CkJsonObject_stringOf $jResp "ticket.id"]
set Is_public [CkJsonObject_stringOf $jResp "ticket.is_public"]
set Macro_id [CkJsonObject_stringOf $jResp "ticket.macro_id"]
set Macro_ids [CkJsonObject_stringOf $jResp "ticket.macro_ids"]
set Organization_id [CkJsonObject_stringOf $jResp "ticket.organization_id"]
set Priority [CkJsonObject_stringOf $jResp "ticket.priority"]
set Problem_id [CkJsonObject_stringOf $jResp "ticket.problem_id"]
set Raw_subject [CkJsonObject_stringOf $jResp "ticket.raw_subject"]
set Recipient [CkJsonObject_stringOf $jResp "ticket.recipient"]
set Safe_update [CkJsonObject_stringOf $jResp "ticket.safe_update"]
set In_11 [CkJsonObject_stringOf $jResp "ticket.satisfaction_rating.in_11"]
set Sharing_agreement_ids [CkJsonObject_stringOf $jResp "ticket.sharing_agreement_ids"]
set Status [CkJsonObject_stringOf $jResp "ticket.status"]
set Subject [CkJsonObject_stringOf $jResp "ticket.subject"]
set Submitter_id [CkJsonObject_stringOf $jResp "ticket.submitter_id"]
set Tags [CkJsonObject_stringOf $jResp "ticket.tags"]
set Ticket_form_id [CkJsonObject_stringOf $jResp "ticket.ticket_form_id"]
set v_Type [CkJsonObject_stringOf $jResp "ticket.type"]
set Updated_at [CkJsonObject_stringOf $jResp "ticket.updated_at"]
set Updated_stamp [CkJsonObject_stringOf $jResp "ticket.updated_stamp"]
set v_Url [CkJsonObject_stringOf $jResp "ticket.url"]
set Channel [CkJsonObject_stringOf $jResp "ticket.via.channel"]
set Ut__a [CkJsonObject_stringOf $jResp "ticket.via.source.Ut__a"]
set Dolored2b [CkJsonObject_IntOf $jResp "ticket.via.source.dolored2b"]
set Mollit1a6 [CkJsonObject_BoolOf $jResp "ticket.via.source.mollit1a6"]
set Via_followup_source_id [CkJsonObject_stringOf $jResp "ticket.via_followup_source_id"]
set Via_id [CkJsonObject_stringOf $jResp "ticket.via_id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket.collaborators"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set email [CkJsonObject_stringOf $jResp "ticket.collaborators[i].email"]
    set name [CkJsonObject_stringOf $jResp "ticket.collaborators[i].name"]
    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

Postman Collection Item JSON

{
  "name": "Show Ticket",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns a number of ticket properties though not the ticket comments. To get the comments, use [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments)\n\n#### Allowed For\n* Agents"
  },
  "response": [
    {
      "name": "Ticket",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id"
          ],
          "variable": [
            {
              "key": "ticket_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket\": {\n    \"requester_id\": \"<integer>\",\n    \"allow_attachments\": \"<boolean>\",\n    \"allow_channelback\": \"<boolean>\",\n    \"assignee_email\": \"<string>\",\n    \"assignee_id\": \"<integer>\",\n    \"attribute_value_ids\": \"<array>\",\n    \"brand_id\": \"<integer>\",\n    \"collaborator_ids\": \"<array>\",\n    \"collaborators\": [\n      {\n        \"email\": \"<email>\",\n        \"name\": \"<string>\"\n      },\n      {\n        \"email\": \"<email>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"comment\": {},\n    \"created_at\": \"<dateTime>\",\n    \"custom_fields\": \"<array>\",\n    \"custom_status_id\": \"<integer>\",\n    \"description\": \"<string>\",\n    \"due_at\": \"<dateTime>\",\n    \"email_cc_ids\": \"<array>\",\n    \"email_ccs\": {},\n    \"external_id\": \"<string>\",\n    \"follower_ids\": \"<array>\",\n    \"followers\": {},\n    \"followup_ids\": \"<array>\",\n    \"forum_topic_id\": \"<integer>\",\n    \"from_messaging_channel\": \"<boolean>\",\n    \"group_id\": \"<integer>\",\n    \"has_incidents\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"is_public\": \"<boolean>\",\n    \"macro_id\": \"<integer>\",\n    \"macro_ids\": \"<array>\",\n    \"metadata\": {},\n    \"organization_id\": \"<integer>\",\n    \"priority\": \"normal\",\n    \"problem_id\": \"<integer>\",\n    \"raw_subject\": \"<string>\",\n    \"recipient\": \"<string>\",\n    \"requester\": {},\n    \"safe_update\": \"<boolean>\",\n    \"satisfaction_rating\": {\n      \"in_11\": -9796534.714120895\n    },\n    \"sharing_agreement_ids\": \"<array>\",\n    \"status\": \"hold\",\n    \"subject\": \"<string>\",\n    \"submitter_id\": \"<integer>\",\n    \"tags\": \"<array>\",\n    \"ticket_form_id\": \"<integer>\",\n    \"type\": \"question\",\n    \"updated_at\": \"<dateTime>\",\n    \"updated_stamp\": \"<string>\",\n    \"url\": \"<string>\",\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"Ut__a\": -44750185.46031158,\n        \"dolored2b\": 8252599,\n        \"mollit1a6\": true\n      }\n    },\n    \"via_followup_source_id\": \"<integer>\",\n    \"via_id\": \"<integer>\",\n    \"voice_comment\": {}\n  }\n}"
    }
  ]
}

Chilkat Online Tools

TCL / Support API / Show Ticket

Curl Command

Postman Collection Item JSON