Chilkat Online Tools

lianja / Support API / Show Ticket Field

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/ticket_fields/:ticket_field_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_field": {
//     "type": "<string>",
//     "title": "<string>",
//     "active": "<boolean>",
//     "agent_description": "<string>",
//     "collapsed_for_agents": "<boolean>",
//     "created_at": "<dateTime>",
//     "custom_field_options": [
//       {
//         "name": "<string>",
//         "value": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "raw_name": "<string>",
//         "url": "<string>"
//       },
//       {
//         "name": "<string>",
//         "value": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "raw_name": "<string>",
//         "url": "<string>"
//       }
//     ],
//     "custom_statuses": [
//       {
//         "active": "<boolean>",
//         "agent_label": "<string>",
//         "created_at": "<dateTime>",
//         "default": "<boolean>",
//         "description": "<string>",
//         "end_user_description": "<string>",
//         "end_user_label": "<string>",
//         "id": "<integer>",
//         "status_category": "solved",
//         "updated_at": "<dateTime>"
//       },
//       {
//         "active": "<boolean>",
//         "agent_label": "<string>",
//         "created_at": "<dateTime>",
//         "default": "<boolean>",
//         "description": "<string>",
//         "end_user_description": "<string>",
//         "end_user_label": "<string>",
//         "id": "<integer>",
//         "status_category": "open",
//         "updated_at": "<dateTime>"
//       }
//     ],
//     "description": "<string>",
//     "editable_in_portal": "<boolean>",
//     "id": "<integer>",
//     "position": "<integer>",
//     "raw_description": "<string>",
//     "raw_title": "<string>",
//     "raw_title_in_portal": "<string>",
//     "regexp_for_validation": "<string>",
//     "relationship_filter": {},
//     "relationship_target_type": "<string>",
//     "removable": "<boolean>",
//     "required": "<boolean>",
//     "required_in_portal": "<boolean>",
//     "sub_type_id": "<integer>",
//     "system_field_options": [
//       {
//         "name": "<string>",
//         "value": "<string>"
//       },
//       {
//         "name": "<string>",
//         "value": "<string>"
//       }
//     ],
//     "tag": "<string>",
//     "title_in_portal": "<string>",
//     "updated_at": "<dateTime>",
//     "url": "<string>",
//     "visible_in_portal": "<boolean>"
//   }
// }

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

lcV_Type = loJResp.StringOf("ticket_field.type")
lcTitle = loJResp.StringOf("ticket_field.title")
lcActive = loJResp.StringOf("ticket_field.active")
lcAgent_description = loJResp.StringOf("ticket_field.agent_description")
lcCollapsed_for_agents = loJResp.StringOf("ticket_field.collapsed_for_agents")
lcCreated_at = loJResp.StringOf("ticket_field.created_at")
lcDescription = loJResp.StringOf("ticket_field.description")
lcEditable_in_portal = loJResp.StringOf("ticket_field.editable_in_portal")
lcId = loJResp.StringOf("ticket_field.id")
lcPosition = loJResp.StringOf("ticket_field.position")
lcRaw_description = loJResp.StringOf("ticket_field.raw_description")
lcRaw_title = loJResp.StringOf("ticket_field.raw_title")
lcRaw_title_in_portal = loJResp.StringOf("ticket_field.raw_title_in_portal")
lcRegexp_for_validation = loJResp.StringOf("ticket_field.regexp_for_validation")
lcRelationship_target_type = loJResp.StringOf("ticket_field.relationship_target_type")
lcRemovable = loJResp.StringOf("ticket_field.removable")
lcRequired = loJResp.StringOf("ticket_field.required")
lcRequired_in_portal = loJResp.StringOf("ticket_field.required_in_portal")
lcSub_type_id = loJResp.StringOf("ticket_field.sub_type_id")
lcTag = loJResp.StringOf("ticket_field.tag")
lcTitle_in_portal = loJResp.StringOf("ticket_field.title_in_portal")
lcUpdated_at = loJResp.StringOf("ticket_field.updated_at")
lcV_Url = loJResp.StringOf("ticket_field.url")
lcVisible_in_portal = loJResp.StringOf("ticket_field.visible_in_portal")
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_field.custom_field_options")
do while i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("ticket_field.custom_field_options[i].name")
    lcValue = loJResp.StringOf("ticket_field.custom_field_options[i].value")
    lcId = loJResp.StringOf("ticket_field.custom_field_options[i].id")
    lcPosition = loJResp.StringOf("ticket_field.custom_field_options[i].position")
    lcRaw_name = loJResp.StringOf("ticket_field.custom_field_options[i].raw_name")
    lcUrl = loJResp.StringOf("ticket_field.custom_field_options[i].url")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_field.custom_statuses")
do while i < lnCount_i
    loJResp.I = i
    lcActive = loJResp.StringOf("ticket_field.custom_statuses[i].active")
    lcAgent_label = loJResp.StringOf("ticket_field.custom_statuses[i].agent_label")
    lcCreated_at = loJResp.StringOf("ticket_field.custom_statuses[i].created_at")
    lcDefault = loJResp.StringOf("ticket_field.custom_statuses[i].default")
    lcDescription = loJResp.StringOf("ticket_field.custom_statuses[i].description")
    lcEnd_user_description = loJResp.StringOf("ticket_field.custom_statuses[i].end_user_description")
    lcEnd_user_label = loJResp.StringOf("ticket_field.custom_statuses[i].end_user_label")
    lcId = loJResp.StringOf("ticket_field.custom_statuses[i].id")
    lcStatus_category = loJResp.StringOf("ticket_field.custom_statuses[i].status_category")
    lcUpdated_at = loJResp.StringOf("ticket_field.custom_statuses[i].updated_at")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_field.system_field_options")
do while i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("ticket_field.system_field_options[i].name")
    lcValue = loJResp.StringOf("ticket_field.system_field_options[i].value")
    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/ticket_fields/:ticket_field_id

Postman Collection Item JSON

{
  "name": "Show Ticket Field",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_fields/:ticket_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_fields",
        ":ticket_field_id"
      ],
      "variable": [
        {
          "key": "ticket_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed for\n\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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_fields",
            ":ticket_field_id"
          ],
          "variable": [
            {
              "key": "ticket_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_field\": {\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"agent_description\": \"<string>\",\n    \"collapsed_for_agents\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"custom_statuses\": [\n      {\n        \"active\": \"<boolean>\",\n        \"agent_label\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"end_user_description\": \"<string>\",\n        \"end_user_label\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"status_category\": \"solved\",\n        \"updated_at\": \"<dateTime>\"\n      },\n      {\n        \"active\": \"<boolean>\",\n        \"agent_label\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"end_user_description\": \"<string>\",\n        \"end_user_label\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"status_category\": \"open\",\n        \"updated_at\": \"<dateTime>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"editable_in_portal\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"raw_title_in_portal\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"removable\": \"<boolean>\",\n    \"required\": \"<boolean>\",\n    \"required_in_portal\": \"<boolean>\",\n    \"sub_type_id\": \"<integer>\",\n    \"system_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"tag\": \"<string>\",\n    \"title_in_portal\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"visible_in_portal\": \"<boolean>\"\n  }\n}"
    }
  ]
}