Chilkat Online Tools

Ruby / Support API / Ticket Related Information

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/related",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)

# {
#   "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

from_archive = jResp.stringOf("from_archive")
incidents = jResp.stringOf("incidents")
topic_id = jResp.stringOf("topic_id")
Dolor__1 = jResp.IntOf("twitter.dolor__1")
Commodo4b = jResp.BoolOf("twitter.commodo4b")
i = 0
count_i = jResp.SizeOfArray("followup_source_ids")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("followup_source_ids[i]")
    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/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}"
    }
  ]
}