TCL / Support API / List OLA Policies
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/olas/policies" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set count [CkJsonObject_stringOf $jResp "count"]
set next_page [CkJsonObject_stringOf $jResp "next_page"]
set previous_page [CkJsonObject_stringOf $jResp "previous_page"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ola_policies"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set title [CkJsonObject_stringOf $jResp "ola_policies[i].title"]
set created_at [CkJsonObject_stringOf $jResp "ola_policies[i].created_at"]
set description [CkJsonObject_stringOf $jResp "ola_policies[i].description"]
set id [CkJsonObject_stringOf $jResp "ola_policies[i].id"]
set position [CkJsonObject_stringOf $jResp "ola_policies[i].position"]
set updated_at [CkJsonObject_stringOf $jResp "ola_policies[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "ola_policies[i].url"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "ola_policies[i].filter.all"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "ola_policies[i].filter.all[j].field"]
set operator [CkJsonObject_stringOf $jResp "ola_policies[i].filter.all[j].operator"]
set value [CkJsonObject_stringOf $jResp "ola_policies[i].filter.all[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "ola_policies[i].filter.any"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "ola_policies[i].filter.any[j].field"]
set operator [CkJsonObject_stringOf $jResp "ola_policies[i].filter.any[j].operator"]
set value [CkJsonObject_stringOf $jResp "ola_policies[i].filter.any[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "ola_policies[i].policy_metrics"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set business_hours [CkJsonObject_stringOf $jResp "ola_policies[i].policy_metrics[j].business_hours"]
set metric [CkJsonObject_stringOf $jResp "ola_policies[i].policy_metrics[j].metric"]
set priority [CkJsonObject_stringOf $jResp "ola_policies[i].policy_metrics[j].priority"]
set target [CkJsonObject_stringOf $jResp "ola_policies[i].policy_metrics[j].target"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
