Chilkat Online Tools

Delphi (DLL) / Support API / Show Ticket Field

Back to Collection Items

var

begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);name := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].name');value := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].value');id := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].id');position := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].position');raw_name := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].raw_name');url := CkJsonObject__stringOf(jResp,'ticket_field.custom_field_options[i].url');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'ticket_field.custom_statuses');CkJsonObject_putI(jResp,i);active := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].active');agent_label := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].agent_label');created_at := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].created_at');default := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].default');description := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].description');end_user_description := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].end_user_description');end_user_label := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].end_user_label');id := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].id');status_category := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].status_category');updated_at := CkJsonObject__stringOf(jResp,'ticket_field.custom_statuses[i].updated_at');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'ticket_field.system_field_options');CkJsonObject_putI(jResp,i);name := CkJsonObject__stringOf(jResp,'ticket_field.system_field_options[i].name');value := CkJsonObject__stringOf(jResp,'ticket_field.system_field_options[i].value');i := i + 1;

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