Chilkat Online Tools

Android / Support API / List Automations

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");

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

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/automations",sbResponseBody);
    if (success == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

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

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

    int respStatusCode = http.get_LastStatus();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, http.lastHeader());
        Log.i(TAG, "Failed.");
        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "automations": [
    //     {
    //       "actions": [
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "active": "<boolean>",
    //       "conditions": {
    //         "all": [
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           }
    //         ],
    //         "any": [
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           }
    //         ]
    //       },
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "raw_title": "<string>",
    //       "title": "<string>",
    //       "updated_at": "<dateTime>"
    //     },
    //     {
    //       "actions": [
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "active": "<boolean>",
    //       "conditions": {
    //         "all": [
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           }
    //         ],
    //         "any": [
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "operator": "<string>",
    //             "value": "<string>"
    //           }
    //         ]
    //       },
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "raw_title": "<string>",
    //       "title": "<string>",
    //       "updated_at": "<dateTime>"
    //     }
    //   ],
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "previous_page": "<string>"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    String active;
    String created_at;
    String default;
    String id;
    String position;
    String raw_title;
    String title;
    String updated_at;
    int j;
    int count_j;
    String field;
    String value;
    String operator;

    String count = jResp.stringOf("count");
    String next_page = jResp.stringOf("next_page");
    String previous_page = jResp.stringOf("previous_page");
    int i = 0;
    int count_i = jResp.SizeOfArray("automations");
    while (i < count_i) {
        jResp.put_I(i);
        active = jResp.stringOf("automations[i].active");
        created_at = jResp.stringOf("automations[i].created_at");
        default = jResp.stringOf("automations[i].default");
        id = jResp.stringOf("automations[i].id");
        position = jResp.stringOf("automations[i].position");
        raw_title = jResp.stringOf("automations[i].raw_title");
        title = jResp.stringOf("automations[i].title");
        updated_at = jResp.stringOf("automations[i].updated_at");
        j = 0;
        count_j = jResp.SizeOfArray("automations[i].actions");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("automations[i].actions[j].field");
            value = jResp.stringOf("automations[i].actions[j].value");
            j = j + 1;
            }

        j = 0;
        count_j = jResp.SizeOfArray("automations[i].conditions.all");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("automations[i].conditions.all[j].field");
            operator = jResp.stringOf("automations[i].conditions.all[j].operator");
            value = jResp.stringOf("automations[i].conditions.all[j].value");
            j = j + 1;
            }

        j = 0;
        count_j = jResp.SizeOfArray("automations[i].conditions.any");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("automations[i].conditions.any[j].field");
            operator = jResp.stringOf("automations[i].conditions.any[j].operator");
            value = jResp.stringOf("automations[i].conditions.any[j].value");
            j = j + 1;
            }

        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 -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations

Postman Collection Item JSON

{
  "name": "List Automations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/automations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "automations"
      ]
    },
    "description": "Lists all automations for the current account.\n\n#### Allowed For\n\n* Agents\n\n#### Available Parameters\n\nYou can pass in any combination of the following optional filters:\n\n| Name       | Type    | Comment\n| ---------- | ------- | -------\n| active     | boolean | Only active automations if true, inactive automations if false\n| sort_by    | string  | Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"\n| sort_order | string  | One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others\n\n#### Sideloads\n\nThe following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.\n\n| Name             | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each automation, if present\n| permissions      | The permissions for each automation\n| usage_1h         | The number of times each automation has been used in the past hour\n| usage_24h        | The number of times each automation has been used in the past day\n| usage_7d         | The number of times each automation has been used in the past week\n| usage_30d        | The number of times each automation has been used in the past thirty days\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\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/automations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "automations"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"automations\": [\n    {\n      \"actions\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_title\": \"<string>\",\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"actions\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_title\": \"<string>\",\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}