Swift3 / Support API / List OLA Policies
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
http.setRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://example.zendesk.com/api/v2/olas/policies", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("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
var title: String?
var created_at: String?
var description: String?
var id: String?
var position: String?
var updated_at: String?
var url: String?
var j: Int
var count_j: Int
var field: String?
var operator: String?
var value: String?
var business_hours: String?
var metric: String?
var priority: String?
var target: String?
var count: String? = jResp.string(of: "count")
var next_page: String? = jResp.string(of: "next_page")
var previous_page: String? = jResp.string(of: "previous_page")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "ola_policies").intValue
while i < count_i {
jResp.i = i
title = jResp.string(of: "ola_policies[i].title")
created_at = jResp.string(of: "ola_policies[i].created_at")
description = jResp.string(of: "ola_policies[i].description")
id = jResp.string(of: "ola_policies[i].id")
position = jResp.string(of: "ola_policies[i].position")
updated_at = jResp.string(of: "ola_policies[i].updated_at")
url = jResp.string(of: "ola_policies[i].url")
j = 0
count_j = jResp.size(ofArray: "ola_policies[i].filter.all").intValue
while j < count_j {
jResp.j = j
field = jResp.string(of: "ola_policies[i].filter.all[j].field")
operator = jResp.string(of: "ola_policies[i].filter.all[j].operator")
value = jResp.string(of: "ola_policies[i].filter.all[j].value")
j = j + 1
}
j = 0
count_j = jResp.size(ofArray: "ola_policies[i].filter.any").intValue
while j < count_j {
jResp.j = j
field = jResp.string(of: "ola_policies[i].filter.any[j].field")
operator = jResp.string(of: "ola_policies[i].filter.any[j].operator")
value = jResp.string(of: "ola_policies[i].filter.any[j].value")
j = j + 1
}
j = 0
count_j = jResp.size(ofArray: "ola_policies[i].policy_metrics").intValue
while j < count_j {
jResp.j = j
business_hours = jResp.string(of: "ola_policies[i].policy_metrics[j].business_hours")
metric = jResp.string(of: "ola_policies[i].policy_metrics[j].metric")
priority = jResp.string(of: "ola_policies[i].policy_metrics[j].priority")
target = jResp.string(of: "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}"
}
]
}