PowerBuilder / Support API / Preview Views
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Duis8
string ls_Ullamco_0
integer li_Officia_13e
string ls_Ipsum_7
integer li_In_a8
integer li_Laborum_a27
string ls_Ea85c
integer li_Occaecat_04
string ls_Qui82a
integer li_Velit21
string ls_Ex_f
string ls_Excepteur_92
integer li_Cillum4
string ls_Active
string ls_Laborum_8
integer li_Consequata
string ls_Created_at
string ls_Default
string ls_Description
integer li_Deserunt6
string ls_Eu7df
string ls_Utd70
integer li_Aute_03
integer li_Culpa_5b2
string ls_Id
string ls_Position
string ls_Exercitatione1
string ls_Magna_b_3
string ls_Title
string ls_Updated_at
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("POST","https://example.zendesk.com/api/v2/views/preview")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Active = loo_JResp.StringOf("view.active")
ls_Laborum_8 = loo_JResp.StringOf("view.conditions.laborum_8")
li_Consequata = loo_JResp.IntOf("view.conditions.consequata")
ls_Created_at = loo_JResp.StringOf("view.created_at")
ls_Default = loo_JResp.StringOf("view.default")
ls_Description = loo_JResp.StringOf("view.description")
li_Deserunt6 = loo_JResp.BoolOf("view.execution.deserunt6")
ls_Eu7df = loo_JResp.StringOf("view.execution.eu7df")
ls_Utd70 = loo_JResp.StringOf("view.execution.utd70")
li_Aute_03 = loo_JResp.BoolOf("view.execution.aute_03")
li_Culpa_5b2 = loo_JResp.IntOf("view.execution.culpa_5b2")
ls_Id = loo_JResp.StringOf("view.id")
ls_Position = loo_JResp.StringOf("view.position")
ls_Exercitatione1 = loo_JResp.StringOf("view.restriction.exercitatione1")
ls_Magna_b_3 = loo_JResp.StringOf("view.restriction.magna_b_3")
ls_Title = loo_JResp.StringOf("view.title")
ls_Updated_at = loo_JResp.StringOf("view.updated_at")
i = 0
li_Count_i = loo_JResp.SizeOfArray("columns")
do while i < li_Count_i
loo_JResp.I = i
li_Duis8 = loo_JResp.IntOf("columns[i].Duis8")
ls_Ullamco_0 = loo_JResp.StringOf("columns[i].ullamco_0")
li_Officia_13e = loo_JResp.IntOf("columns[i].officia_13e")
ls_Ipsum_7 = loo_JResp.StringOf("columns[i].ipsum_7")
li_In_a8 = loo_JResp.BoolOf("columns[i].in_a8")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("groups")
do while i < li_Count_i
loo_JResp.I = i
li_Laborum_a27 = loo_JResp.BoolOf("groups[i].laborum_a27")
ls_Ea85c = loo_JResp.StringOf("groups[i].ea85c")
li_Occaecat_04 = loo_JResp.IntOf("groups[i].occaecat_04")
ls_Qui82a = loo_JResp.StringOf("groups[i].qui82a")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("rows")
do while i < li_Count_i
loo_JResp.I = i
li_Velit21 = loo_JResp.IntOf("rows[i].velit21")
ls_Ex_f = loo_JResp.StringOf("rows[i].ex_f")
ls_Excepteur_92 = loo_JResp.StringOf("rows[i].Excepteur_92")
li_Cillum4 = loo_JResp.IntOf("rows[i].cillum4")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
