Chilkat Online Tools

Go / Support API / List OLA Policies

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

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

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        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

    var title *string = new(string)
    var created_at *string = new(string)
    var description *string = new(string)
    var id *string = new(string)
    var position *string = new(string)
    var updated_at *string = new(string)
    var url *string = new(string)
    var j int
    var count_j int
    var field *string = new(string)
    var operator *string = new(string)
    var value *string = new(string)
    var business_hours *string = new(string)
    var metric *string = new(string)
    var priority *string = new(string)
    var target *string = new(string)

    count := jResp.StringOf("count")
    next_page := jResp.StringOf("next_page")
    previous_page := jResp.StringOf("previous_page")
    i := 0
    count_i := jResp.SizeOfArray("ola_policies")
    for i < count_i {
        jResp.SetI(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")
        for j < count_j {
            jResp.SetJ(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")
        for j < count_j {
            jResp.SetJ(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")
        for j < count_j {
            jResp.SetJ(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
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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