Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "sort_by" "<string>"
CkJsonObject_UpdateString $queryParams "sort_order" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/views/:view_id/execute" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Active [CkJsonObject_stringOf $jResp "view.active"]
set Laborum_8 [CkJsonObject_stringOf $jResp "view.conditions.laborum_8"]
set Consequata [CkJsonObject_IntOf $jResp "view.conditions.consequata"]
set Created_at [CkJsonObject_stringOf $jResp "view.created_at"]
set Default [CkJsonObject_stringOf $jResp "view.default"]
set Description [CkJsonObject_stringOf $jResp "view.description"]
set Deserunt6 [CkJsonObject_BoolOf $jResp "view.execution.deserunt6"]
set Eu7df [CkJsonObject_stringOf $jResp "view.execution.eu7df"]
set Utd70 [CkJsonObject_stringOf $jResp "view.execution.utd70"]
set Aute_03 [CkJsonObject_BoolOf $jResp "view.execution.aute_03"]
set Culpa_5b2 [CkJsonObject_IntOf $jResp "view.execution.culpa_5b2"]
set Id [CkJsonObject_stringOf $jResp "view.id"]
set Position [CkJsonObject_stringOf $jResp "view.position"]
set Exercitatione1 [CkJsonObject_stringOf $jResp "view.restriction.exercitatione1"]
set Magna_b_3 [CkJsonObject_stringOf $jResp "view.restriction.magna_b_3"]
set Title [CkJsonObject_stringOf $jResp "view.title"]
set Updated_at [CkJsonObject_stringOf $jResp "view.updated_at"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "columns"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Duis8 [CkJsonObject_IntOf $jResp "columns[i].Duis8"]
set ullamco_0 [CkJsonObject_stringOf $jResp "columns[i].ullamco_0"]
set officia_13e [CkJsonObject_IntOf $jResp "columns[i].officia_13e"]
set ipsum_7 [CkJsonObject_stringOf $jResp "columns[i].ipsum_7"]
set in_a8 [CkJsonObject_BoolOf $jResp "columns[i].in_a8"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "groups"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set laborum_a27 [CkJsonObject_BoolOf $jResp "groups[i].laborum_a27"]
set ea85c [CkJsonObject_stringOf $jResp "groups[i].ea85c"]
set occaecat_04 [CkJsonObject_IntOf $jResp "groups[i].occaecat_04"]
set qui82a [CkJsonObject_stringOf $jResp "groups[i].qui82a"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "rows"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set velit21 [CkJsonObject_IntOf $jResp "rows[i].velit21"]
set ex_f [CkJsonObject_stringOf $jResp "rows[i].ex_f"]
set Excepteur_92 [CkJsonObject_stringOf $jResp "rows[i].Excepteur_92"]
set cillum4 [CkJsonObject_IntOf $jResp "rows[i].cillum4"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
