lianja / Support API / Show Ticket
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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
lcRequester_id = loJResp.StringOf("ticket.requester_id")
lcAllow_attachments = loJResp.StringOf("ticket.allow_attachments")
lcAllow_channelback = loJResp.StringOf("ticket.allow_channelback")
lcAssignee_email = loJResp.StringOf("ticket.assignee_email")
lcAssignee_id = loJResp.StringOf("ticket.assignee_id")
lcAttribute_value_ids = loJResp.StringOf("ticket.attribute_value_ids")
lcBrand_id = loJResp.StringOf("ticket.brand_id")
lcCollaborator_ids = loJResp.StringOf("ticket.collaborator_ids")
lcCreated_at = loJResp.StringOf("ticket.created_at")
lcCustom_fields = loJResp.StringOf("ticket.custom_fields")
lcCustom_status_id = loJResp.StringOf("ticket.custom_status_id")
lcDescription = loJResp.StringOf("ticket.description")
lcDue_at = loJResp.StringOf("ticket.due_at")
lcEmail_cc_ids = loJResp.StringOf("ticket.email_cc_ids")
lcExternal_id = loJResp.StringOf("ticket.external_id")
lcFollower_ids = loJResp.StringOf("ticket.follower_ids")
lcFollowup_ids = loJResp.StringOf("ticket.followup_ids")
lcForum_topic_id = loJResp.StringOf("ticket.forum_topic_id")
lcFrom_messaging_channel = loJResp.StringOf("ticket.from_messaging_channel")
lcGroup_id = loJResp.StringOf("ticket.group_id")
lcHas_incidents = loJResp.StringOf("ticket.has_incidents")
lcId = loJResp.StringOf("ticket.id")
lcIs_public = loJResp.StringOf("ticket.is_public")
lcMacro_id = loJResp.StringOf("ticket.macro_id")
lcMacro_ids = loJResp.StringOf("ticket.macro_ids")
lcOrganization_id = loJResp.StringOf("ticket.organization_id")
lcPriority = loJResp.StringOf("ticket.priority")
lcProblem_id = loJResp.StringOf("ticket.problem_id")
lcRaw_subject = loJResp.StringOf("ticket.raw_subject")
lcRecipient = loJResp.StringOf("ticket.recipient")
lcSafe_update = loJResp.StringOf("ticket.safe_update")
lcIn_11 = loJResp.StringOf("ticket.satisfaction_rating.in_11")
lcSharing_agreement_ids = loJResp.StringOf("ticket.sharing_agreement_ids")
lcStatus = loJResp.StringOf("ticket.status")
lcSubject = loJResp.StringOf("ticket.subject")
lcSubmitter_id = loJResp.StringOf("ticket.submitter_id")
lcTags = loJResp.StringOf("ticket.tags")
lcTicket_form_id = loJResp.StringOf("ticket.ticket_form_id")
lcV_Type = loJResp.StringOf("ticket.type")
lcUpdated_at = loJResp.StringOf("ticket.updated_at")
lcUpdated_stamp = loJResp.StringOf("ticket.updated_stamp")
lcV_Url = loJResp.StringOf("ticket.url")
lcChannel = loJResp.StringOf("ticket.via.channel")
lcUt__a = loJResp.StringOf("ticket.via.source.Ut__a")
lnDolored2b = loJResp.IntOf("ticket.via.source.dolored2b")
llMollit1a6 = loJResp.BoolOf("ticket.via.source.mollit1a6")
lcVia_followup_source_id = loJResp.StringOf("ticket.via_followup_source_id")
lcVia_id = loJResp.StringOf("ticket.via_id")
i = 0
lnCount_i = loJResp.SizeOfArray("ticket.collaborators")
do while i < lnCount_i
loJResp.I = i
lcEmail = loJResp.StringOf("ticket.collaborators[i].email")
lcName = loJResp.StringOf("ticket.collaborators[i].name")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
