Foxpro / Support API / Execute View
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnDuis8
LOCAL lcUllamco_0
LOCAL lnOfficia_13e
LOCAL lcIpsum_7
LOCAL lnIn_a8
LOCAL lnLaborum_a27
LOCAL lcEa85c
LOCAL lnOccaecat_04
LOCAL lcQui82a
LOCAL lnVelit21
LOCAL lcEx_f
LOCAL lcExcepteur_92
LOCAL lnCillum4
LOCAL lcActive
LOCAL lcLaborum_8
LOCAL lnConsequata
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lnDeserunt6
LOCAL lcEu7df
LOCAL lcUtd70
LOCAL lnAute_03
LOCAL lnCulpa_5b2
LOCAL lcId
LOCAL lcPosition
LOCAL lcExercitatione1
LOCAL lcMagna_b_3
LOCAL lcTitle
LOCAL lcUpdated_at
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("sort_by","<string>")
loQueryParams.UpdateString("sort_order","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/views/:view_id/execute",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcActive = loJResp.StringOf("view.active")
lcLaborum_8 = loJResp.StringOf("view.conditions.laborum_8")
lnConsequata = loJResp.IntOf("view.conditions.consequata")
lcCreated_at = loJResp.StringOf("view.created_at")
lcDefault = loJResp.StringOf("view.default")
lcDescription = loJResp.StringOf("view.description")
lnDeserunt6 = loJResp.BoolOf("view.execution.deserunt6")
lcEu7df = loJResp.StringOf("view.execution.eu7df")
lcUtd70 = loJResp.StringOf("view.execution.utd70")
lnAute_03 = loJResp.BoolOf("view.execution.aute_03")
lnCulpa_5b2 = loJResp.IntOf("view.execution.culpa_5b2")
lcId = loJResp.StringOf("view.id")
lcPosition = loJResp.StringOf("view.position")
lcExercitatione1 = loJResp.StringOf("view.restriction.exercitatione1")
lcMagna_b_3 = loJResp.StringOf("view.restriction.magna_b_3")
lcTitle = loJResp.StringOf("view.title")
lcUpdated_at = loJResp.StringOf("view.updated_at")
i = 0
lnCount_i = loJResp.SizeOfArray("columns")
DO WHILE i < lnCount_i
loJResp.I = i
lnDuis8 = loJResp.IntOf("columns[i].Duis8")
lcUllamco_0 = loJResp.StringOf("columns[i].ullamco_0")
lnOfficia_13e = loJResp.IntOf("columns[i].officia_13e")
lcIpsum_7 = loJResp.StringOf("columns[i].ipsum_7")
lnIn_a8 = loJResp.BoolOf("columns[i].in_a8")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("groups")
DO WHILE i < lnCount_i
loJResp.I = i
lnLaborum_a27 = loJResp.BoolOf("groups[i].laborum_a27")
lcEa85c = loJResp.StringOf("groups[i].ea85c")
lnOccaecat_04 = loJResp.IntOf("groups[i].occaecat_04")
lcQui82a = loJResp.StringOf("groups[i].qui82a")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("rows")
DO WHILE i < lnCount_i
loJResp.I = i
lnVelit21 = loJResp.IntOf("rows[i].velit21")
lcEx_f = loJResp.StringOf("rows[i].ex_f")
lcExcepteur_92 = loJResp.StringOf("rows[i].Excepteur_92")
lnCillum4 = loJResp.IntOf("rows[i].cillum4")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
