Swift / Support API / Execute View
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.BasicAuth = true
http.Login = "login"
http.Password = "password"
let queryParams = CkoJsonObject()
queryParams.UpdateString("sort_by", value: "<string>")
queryParams.UpdateString("sort_order", value: "<string>")
http.SetRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://example.zendesk.com/api/v2/views/:view_id/execute", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Duis8: Int
var ullamco_0: String?
var officia_13e: Int
var ipsum_7: String?
var in_a8: Bool
var laborum_a27: Bool
var ea85c: String?
var occaecat_04: Int
var qui82a: String?
var velit21: Int
var ex_f: String?
var Excepteur_92: String?
var cillum4: Int
var Active: String? = jResp.StringOf("view.active")
var Laborum_8: String? = jResp.StringOf("view.conditions.laborum_8")
var Consequata: Int = jResp.IntOf("view.conditions.consequata").intValue
var Created_at: String? = jResp.StringOf("view.created_at")
var Default: String? = jResp.StringOf("view.default")
var Description: String? = jResp.StringOf("view.description")
var Deserunt6: Bool = jResp.BoolOf("view.execution.deserunt6")
var Eu7df: String? = jResp.StringOf("view.execution.eu7df")
var Utd70: String? = jResp.StringOf("view.execution.utd70")
var Aute_03: Bool = jResp.BoolOf("view.execution.aute_03")
var Culpa_5b2: Int = jResp.IntOf("view.execution.culpa_5b2").intValue
var Id: String? = jResp.StringOf("view.id")
var Position: String? = jResp.StringOf("view.position")
var Exercitatione1: String? = jResp.StringOf("view.restriction.exercitatione1")
var Magna_b_3: String? = jResp.StringOf("view.restriction.magna_b_3")
var Title: String? = jResp.StringOf("view.title")
var Updated_at: String? = jResp.StringOf("view.updated_at")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("columns").intValue
while i < count_i {
jResp.I = i
Duis8 = jResp.IntOf("columns[i].Duis8").intValue
ullamco_0 = jResp.StringOf("columns[i].ullamco_0")
officia_13e = jResp.IntOf("columns[i].officia_13e").intValue
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").intValue
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").intValue
qui82a = jResp.StringOf("groups[i].qui82a")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("rows").intValue
while i < count_i {
jResp.I = i
velit21 = jResp.IntOf("rows[i].velit21").intValue
ex_f = jResp.StringOf("rows[i].ex_f")
Excepteur_92 = jResp.StringOf("rows[i].Excepteur_92")
cillum4 = jResp.IntOf("rows[i].cillum4").intValue
i = i + 1
}
}
Curl Command
curl -u login:password -G -d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/:view_id/execute
Postman Collection Item JSON
{
"name": "Execute View",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/:view_id/execute?sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
":view_id",
"execute"
],
"query": [
{
"key": "sort_by",
"value": "<string>",
"description": "The ticket field used for sorting. This will either be a title or a custom field id."
},
{
"key": "sort_order",
"value": "<string>",
"description": "The direction the tickets are sorted. May be one of 'asc' or 'desc'"
}
],
"variable": [
{
"key": "view_id",
"value": "<integer>"
}
]
},
"description": "Returns the column titles and the rows of the specified view.\n\nThe `columns` array lists the view's column titles and includes only views parameters.\n\nThe `rows` array lists the values of each column for each ticket and includes parameters from both views and tickets. Though not displayed in the view, a partial ticket object is included with each row object.\n\n**Note**: To get the full ticket objects for a specified view, use [List Tickets from a View](#list-tickets-from-a-view).\n\nThis endpoint is rate limited to 5 requests per minute, per view, per agent.\n\nThe view execution system is designed for periodic rather than high-frequency API usage. In particular, views called very frequently may be cached by Zendesk. This means that the API client will still receive a result, but that result may have been computed at any time within the last 10 minutes.\n\nZendesk recommends using the Incremental Ticket Export endpoint to get the latest changes. You can call it more often, and it returns all the tickets that changed since the last poll. For details and rate limits, see [Incremental Exports](/api-reference/ticketing/ticket-management/incremental_exports/).\n\nView output sorting can be controlled by passing the `sort_by` and `sort_order` parameters in the format described in the table in [Preview Views](#preview-views).\n\n#### 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/views/:view_id/execute?sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
":view_id",
"execute"
],
"query": [
{
"key": "sort_by",
"value": "<string>",
"description": "The ticket field used for sorting. This will either be a title or a custom field id."
},
{
"key": "sort_order",
"value": "<string>",
"description": "The direction the tickets are sorted. May be one of 'asc' or 'desc'"
}
],
"variable": [
{
"key": "view_id"
}
]
}
},
"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}"
}
]
}
