Chilkat Online Tools

Ruby / Support API / Show Ticket

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

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

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}"
    }
  ]
}