Chilkat Online Tools

Java / Support API / List OLA Policies

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // 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/olas/policies",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

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

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

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

    // {
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "ola_policies": [
    //     {
    //       "title": "<string>",
    //       "filter": {
    //         "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>",
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "policy_metrics": [
    //         {
    //           "business_hours": "<boolean>",
    //           "metric": "<string>",
    //           "priority": "<string>",
    //           "target": "<integer>"
    //         },
    //         {
    //           "business_hours": "<boolean>",
    //           "metric": "<string>",
    //           "priority": "<string>",
    //           "target": "<integer>"
    //         }
    //       ],
    //       "position": "<integer>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>"
    //     },
    //     {
    //       "title": "<string>",
    //       "filter": {
    //         "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>",
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "policy_metrics": [
    //         {
    //           "business_hours": "<boolean>",
    //           "metric": "<string>",
    //           "priority": "<string>",
    //           "target": "<integer>"
    //         },
    //         {
    //           "business_hours": "<boolean>",
    //           "metric": "<string>",
    //           "priority": "<string>",
    //           "target": "<integer>"
    //         }
    //       ],
    //       "position": "<integer>",
    //       "updated_at": "<dateTime>",
    //       "url": "<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 title;
    String created_at;
    String description;
    String id;
    String position;
    String updated_at;
    String url;
    int j;
    int count_j;
    String field;
    String operator;
    String value;
    String business_hours;
    String metric;
    String priority;
    String target;

    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("ola_policies");
    while (i < count_i) {
        jResp.put_I(i);
        title = jResp.stringOf("ola_policies[i].title");
        created_at = jResp.stringOf("ola_policies[i].created_at");
        description = jResp.stringOf("ola_policies[i].description");
        id = jResp.stringOf("ola_policies[i].id");
        position = jResp.stringOf("ola_policies[i].position");
        updated_at = jResp.stringOf("ola_policies[i].updated_at");
        url = jResp.stringOf("ola_policies[i].url");
        j = 0;
        count_j = jResp.SizeOfArray("ola_policies[i].filter.all");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("ola_policies[i].filter.all[j].field");
            operator = jResp.stringOf("ola_policies[i].filter.all[j].operator");
            value = jResp.stringOf("ola_policies[i].filter.all[j].value");
            j = j+1;
            }

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

        j = 0;
        count_j = jResp.SizeOfArray("ola_policies[i].policy_metrics");
        while (j < count_j) {
            jResp.put_J(j);
            business_hours = jResp.stringOf("ola_policies[i].policy_metrics[j].business_hours");
            metric = jResp.stringOf("ola_policies[i].policy_metrics[j].metric");
            priority = jResp.stringOf("ola_policies[i].policy_metrics[j].priority");
            target = jResp.stringOf("ola_policies[i].policy_metrics[j].target");
            j = j+1;
            }

        i = i+1;
        }
  }
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies

Postman Collection Item JSON

{
  "name": "List OLA Policies",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies"
      ]
    },
    "description": "#### Allowed For\n\n* Admins\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/olas/policies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"ola_policies\": [\n    {\n      \"title\": \"<string>\",\n      \"filter\": {\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      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"policy_metrics\": [\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        },\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        }\n      ],\n      \"position\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"title\": \"<string>\",\n      \"filter\": {\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      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"policy_metrics\": [\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        },\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        }\n      ],\n      \"position\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}