Chilkat Online Tools

Android / Support API / Execute View

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("sort_by","<string>");
    queryParams.UpdateString("sort_order","<string>");

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/views/:view_id/execute",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "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;
    boolean in_a8;
    boolean 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");
    boolean Deserunt6 = jResp.BoolOf("view.execution.deserunt6");
    String Eu7df = jResp.stringOf("view.execution.eu7df");
    String Utd70 = jResp.stringOf("view.execution.utd70");
    boolean 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.put_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.put_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.put_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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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}"
    }
  ]
}