Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
http.BasicAuth = true;
http.Login = "login";
http.Password = "password";
http.SetRequestHeader("Accept","application/json");
Chilkat.HttpResponse resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/views/preview");
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "columns": [
// {
// "Duis8": -59589120,
// "ullamco_0": "Ut nostrud qui elit dolor"
// },
// {
// "officia_13e": -39842370,
// "ipsum_7": "sunt",
// "in_a8": true
// }
// ],
// "groups": [
// {
// "laborum_a27": false
// },
// {
// "ea85c": 69952708.53230786,
// "occaecat_04": 58869893,
// "qui82a": "L"
// }
// ],
// "rows": [
// {
// "velit21": -89119970
// },
// {
// "ex_f": 92255473.59295204,
// "Excepteur_92": "sunt",
// "cillum4": 24641748
// }
// ],
// "view": {
// "active": "<boolean>",
// "conditions": {
// "laborum_8": 404871.0763479173,
// "consequata": -40432952
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "deserunt6": false,
// "eu7df": "veniam",
// "utd70": -40480339.58192083,
// "aute_03": true,
// "culpa_5b2": -78225658
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "exercitatione1": "in",
// "magna_b_3": -90768253.5149942
// },
// "title": "<string>",
// "updated_at": "<dateTime>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
int Duis8;
string ullamco_0;
int officia_13e;
string ipsum_7;
bool in_a8;
bool laborum_a27;
string ea85c;
int occaecat_04;
string qui82a;
int velit21;
string ex_f;
string Excepteur_92;
int cillum4;
string Active = jResp.StringOf("view.active");
string Laborum_8 = jResp.StringOf("view.conditions.laborum_8");
int Consequata = jResp.IntOf("view.conditions.consequata");
string Created_at = jResp.StringOf("view.created_at");
string Default = jResp.StringOf("view.default");
string Description = jResp.StringOf("view.description");
bool Deserunt6 = jResp.BoolOf("view.execution.deserunt6");
string Eu7df = jResp.StringOf("view.execution.eu7df");
string Utd70 = jResp.StringOf("view.execution.utd70");
bool Aute_03 = jResp.BoolOf("view.execution.aute_03");
int Culpa_5b2 = jResp.IntOf("view.execution.culpa_5b2");
string Id = jResp.StringOf("view.id");
string Position = jResp.StringOf("view.position");
string Exercitatione1 = jResp.StringOf("view.restriction.exercitatione1");
string Magna_b_3 = jResp.StringOf("view.restriction.magna_b_3");
string Title = jResp.StringOf("view.title");
string Updated_at = jResp.StringOf("view.updated_at");
int i = 0;
int count_i = jResp.SizeOfArray("columns");
while (i < count_i) {
jResp.I = i;
Duis8 = jResp.IntOf("columns[i].Duis8");
ullamco_0 = jResp.StringOf("columns[i].ullamco_0");
officia_13e = jResp.IntOf("columns[i].officia_13e");
ipsum_7 = jResp.StringOf("columns[i].ipsum_7");
in_a8 = jResp.BoolOf("columns[i].in_a8");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("groups");
while (i < count_i) {
jResp.I = i;
laborum_a27 = jResp.BoolOf("groups[i].laborum_a27");
ea85c = jResp.StringOf("groups[i].ea85c");
occaecat_04 = jResp.IntOf("groups[i].occaecat_04");
qui82a = jResp.StringOf("groups[i].qui82a");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("rows");
while (i < count_i) {
jResp.I = i;
velit21 = jResp.IntOf("rows[i].velit21");
ex_f = jResp.StringOf("rows[i].ex_f");
Excepteur_92 = jResp.StringOf("rows[i].Excepteur_92");
cillum4 = jResp.IntOf("rows[i].cillum4");
i = i + 1;
}
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/preview
Postman Collection Item JSON
{
"name": "Preview Views",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/preview",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"preview"
]
},
"description": "You can preview views by constructing the conditions in the proper format and nesting them under the `view` property. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference/). The output can also be controlled by passing in any of the following parameters and nesting them under the `output` property.\n\n| Name | Type | Comment\n| --------------- | ------- | -------\n| columns | Array | The ticket fields to display. System fields are looked up by name, custom fields by title or id. See the [View columns](#view-columns) table\n| group_by | String | When present, the field by which the tickets are grouped\n| group_order | String | The direction the tickets are grouped. May be one of \"asc\" or \"desc\"\n| sort_order | String | The direction the tickets are sorted. May be one of \"asc\" or \"desc\"\n| sort_by | String | The ticket field used for sorting. This will either be a title or a custom field id.\n\nThis endpoint is rate limited to 5 requests per minute, per view, per agent.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/preview",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"preview"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"columns\": [\n {\n \"Duis8\": -59589120,\n \"ullamco_0\": \"Ut nostrud qui elit dolor\"\n },\n {\n \"officia_13e\": -39842370,\n \"ipsum_7\": \"sunt\",\n \"in_a8\": true\n }\n ],\n \"groups\": [\n {\n \"laborum_a27\": false\n },\n {\n \"ea85c\": 69952708.53230786,\n \"occaecat_04\": 58869893,\n \"qui82a\": \"L\"\n }\n ],\n \"rows\": [\n {\n \"velit21\": -89119970\n },\n {\n \"ex_f\": 92255473.59295204,\n \"Excepteur_92\": \"sunt\",\n \"cillum4\": 24641748\n }\n ],\n \"view\": {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"laborum_8\": 404871.0763479173,\n \"consequata\": -40432952\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"deserunt6\": false,\n \"eu7df\": \"veniam\",\n \"utd70\": -40480339.58192083,\n \"aute_03\": true,\n \"culpa_5b2\": -78225658\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"exercitatione1\": \"in\",\n \"magna_b_3\": -90768253.5149942\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n}"
}
]
}
