Java / Support API / List Ticket Forms
Back to Collection Items
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
CkJsonObject queryParams = new CkJsonObject();
queryParams.UpdateString("active","<boolean>");
queryParams.UpdateString("end_user_visible","<boolean>");
queryParams.UpdateString("fallback_to_default","<boolean>");
queryParams.UpdateString("associated_to_brand","<boolean>");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/ticket_forms",queryParams);
if (http.get_LastMethodSuccess() == false) {
System.out.println(http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
System.out.println("Response Body:");
System.out.println(jResp.emit());
int respStatusCode = resp.get_StatusCode();
System.out.println("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
System.out.println("Response Header:");
System.out.println(resp.header());
System.out.println("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "ticket_forms": [
// {
// "name": "<string>",
// "active": "<boolean>",
// "agent_conditions": [
// {
// "adipisicing_648": -24086995
// },
// {
// "veniamf": "cupida"
// }
// ],
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "display_name": "<string>",
// "end_user_conditions": [
// {
// "in_6b8": "Ut id",
// "magna1": -6245214
// },
// {
// "pariatur1": 67097325,
// "consectetur3": false,
// "sed_6f0": true
// }
// ],
// "end_user_visible": "<boolean>",
// "id": "<integer>",
// "in_all_brands": "<boolean>",
// "position": "<integer>",
// "raw_display_name": "<string>",
// "raw_name": "<string>",
// "restricted_brand_ids": [
// "<integer>",
// "<integer>"
// ],
// "ticket_field_ids": [
// "<integer>",
// "<integer>"
// ],
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "active": "<boolean>",
// "agent_conditions": [
// {
// "id9": "laborum veniam",
// "ametb8": false
// },
// {
// "ut08f": -79491980.10398532,
// "non81": "Duis est fugiat officia consequat"
// }
// ],
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "display_name": "<string>",
// "end_user_conditions": [
// {
// "sint1d2": "sint ex et"
// },
// {
// "cupidatat_667": true,
// "magna_d8": 64894285.255497575
// }
// ],
// "end_user_visible": "<boolean>",
// "id": "<integer>",
// "in_all_brands": "<boolean>",
// "position": "<integer>",
// "raw_display_name": "<string>",
// "raw_name": "<string>",
// "restricted_brand_ids": [
// "<integer>",
// "<integer>"
// ],
// "ticket_field_ids": [
// "<integer>",
// "<integer>"
// ],
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
String name;
String active;
String created_at;
String default;
String display_name;
String end_user_visible;
String id;
String in_all_brands;
String position;
String raw_display_name;
String raw_name;
String updated_at;
String url;
int j;
int count_j;
int adipisicing_648;
String veniamf;
String id9;
boolean ametb8;
String ut08f;
String non81;
String in_6b8;
int magna1;
int pariatur1;
boolean consectetur3;
boolean sed_6f0;
String sint1d2;
boolean cupidatat_667;
String magna_d8;
String strVal;
int i = 0;
int count_i = jResp.SizeOfArray("ticket_forms");
while (i < count_i) {
jResp.put_I(i);
name = jResp.stringOf("ticket_forms[i].name");
active = jResp.stringOf("ticket_forms[i].active");
created_at = jResp.stringOf("ticket_forms[i].created_at");
default = jResp.stringOf("ticket_forms[i].default");
display_name = jResp.stringOf("ticket_forms[i].display_name");
end_user_visible = jResp.stringOf("ticket_forms[i].end_user_visible");
id = jResp.stringOf("ticket_forms[i].id");
in_all_brands = jResp.stringOf("ticket_forms[i].in_all_brands");
position = jResp.stringOf("ticket_forms[i].position");
raw_display_name = jResp.stringOf("ticket_forms[i].raw_display_name");
raw_name = jResp.stringOf("ticket_forms[i].raw_name");
updated_at = jResp.stringOf("ticket_forms[i].updated_at");
url = jResp.stringOf("ticket_forms[i].url");
j = 0;
count_j = jResp.SizeOfArray("ticket_forms[i].agent_conditions");
while (j < count_j) {
jResp.put_J(j);
adipisicing_648 = jResp.IntOf("ticket_forms[i].agent_conditions[j].adipisicing_648");
veniamf = jResp.stringOf("ticket_forms[i].agent_conditions[j].veniamf");
id9 = jResp.stringOf("ticket_forms[i].agent_conditions[j].id9");
ametb8 = jResp.BoolOf("ticket_forms[i].agent_conditions[j].ametb8");
ut08f = jResp.stringOf("ticket_forms[i].agent_conditions[j].ut08f");
non81 = jResp.stringOf("ticket_forms[i].agent_conditions[j].non81");
j = j+1;
}
j = 0;
count_j = jResp.SizeOfArray("ticket_forms[i].end_user_conditions");
while (j < count_j) {
jResp.put_J(j);
in_6b8 = jResp.stringOf("ticket_forms[i].end_user_conditions[j].in_6b8");
magna1 = jResp.IntOf("ticket_forms[i].end_user_conditions[j].magna1");
pariatur1 = jResp.IntOf("ticket_forms[i].end_user_conditions[j].pariatur1");
consectetur3 = jResp.BoolOf("ticket_forms[i].end_user_conditions[j].consectetur3");
sed_6f0 = jResp.BoolOf("ticket_forms[i].end_user_conditions[j].sed_6f0");
sint1d2 = jResp.stringOf("ticket_forms[i].end_user_conditions[j].sint1d2");
cupidatat_667 = jResp.BoolOf("ticket_forms[i].end_user_conditions[j].cupidatat_667");
magna_d8 = jResp.stringOf("ticket_forms[i].end_user_conditions[j].magna_d8");
j = j+1;
}
j = 0;
count_j = jResp.SizeOfArray("ticket_forms[i].restricted_brand_ids");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf("ticket_forms[i].restricted_brand_ids[j]");
j = j+1;
}
j = 0;
count_j = jResp.SizeOfArray("ticket_forms[i].ticket_field_ids");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf("ticket_forms[i].ticket_field_ids[j]");
j = j+1;
}
i = i+1;
}
}
}
Curl Command
curl -u login:password -G -d "active=%3Cboolean%3E"
-d "end_user_visible=%3Cboolean%3E"
-d "fallback_to_default=%3Cboolean%3E"
-d "associated_to_brand=%3Cboolean%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_forms
Postman Collection Item JSON
{
"name": "List Ticket Forms",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_forms?active=<boolean>&end_user_visible=<boolean>&fallback_to_default=<boolean>&associated_to_brand=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_forms"
],
"query": [
{
"key": "active",
"value": "<boolean>",
"description": "true returns active ticket forms; false returns inactive ticket forms. If not present, returns both"
},
{
"key": "end_user_visible",
"value": "<boolean>",
"description": "true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both"
},
{
"key": "fallback_to_default",
"value": "<boolean>",
"description": "true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms"
},
{
"key": "associated_to_brand",
"value": "<boolean>",
"description": "true returns the ticket forms of the brand specified by the url's subdomain"
}
]
},
"description": "Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have `end_user_visible` set to true.\n\n#### Allowed For\n\n* Anyone\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_forms?active=<boolean>&end_user_visible=<boolean>&fallback_to_default=<boolean>&associated_to_brand=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_forms"
],
"query": [
{
"key": "active",
"value": "<boolean>",
"description": "true returns active ticket forms; false returns inactive ticket forms. If not present, returns both"
},
{
"key": "end_user_visible",
"value": "<boolean>",
"description": "true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both"
},
{
"key": "fallback_to_default",
"value": "<boolean>",
"description": "true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms"
},
{
"key": "associated_to_brand",
"value": "<boolean>",
"description": "true returns the ticket forms of the brand specified by the url's subdomain"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_forms\": [\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_conditions\": [\n {\n \"adipisicing_648\": -24086995\n },\n {\n \"veniamf\": \"cupida\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"display_name\": \"<string>\",\n \"end_user_conditions\": [\n {\n \"in_6b8\": \"Ut id\",\n \"magna1\": -6245214\n },\n {\n \"pariatur1\": 67097325,\n \"consectetur3\": false,\n \"sed_6f0\": true\n }\n ],\n \"end_user_visible\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"in_all_brands\": \"<boolean>\",\n \"position\": \"<integer>\",\n \"raw_display_name\": \"<string>\",\n \"raw_name\": \"<string>\",\n \"restricted_brand_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"ticket_field_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_conditions\": [\n {\n \"id9\": \"laborum veniam\",\n \"ametb8\": false\n },\n {\n \"ut08f\": -79491980.10398532,\n \"non81\": \"Duis est fugiat officia consequat\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"display_name\": \"<string>\",\n \"end_user_conditions\": [\n {\n \"sint1d2\": \"sint ex et\"\n },\n {\n \"cupidatat_667\": true,\n \"magna_d8\": 64894285.255497575\n }\n ],\n \"end_user_visible\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"in_all_brands\": \"<boolean>\",\n \"position\": \"<integer>\",\n \"raw_display_name\": \"<string>\",\n \"raw_name\": \"<string>\",\n \"restricted_brand_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"ticket_field_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
