autoit / Support API / List OLA Policies
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sTitle
Local $sCreated_at
Local $sDescription
Local $sId
Local $sPosition
Local $sUpdated_at
Local $sUrl
Local $iJ
Local $iCount_j
Local $sField
Local $sOperator
Local $sValue
Local $sBusiness_hours
Local $sMetric
Local $sPriority
Local $sTarget
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("ola_policies")
While $i < $iCount_i
$oJResp.I = $i
$sTitle = $oJResp.StringOf("ola_policies[i].title")
$sCreated_at = $oJResp.StringOf("ola_policies[i].created_at")
$sDescription = $oJResp.StringOf("ola_policies[i].description")
$sId = $oJResp.StringOf("ola_policies[i].id")
$sPosition = $oJResp.StringOf("ola_policies[i].position")
$sUpdated_at = $oJResp.StringOf("ola_policies[i].updated_at")
$sUrl = $oJResp.StringOf("ola_policies[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("ola_policies[i].filter.all")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sField = $oJResp.StringOf("ola_policies[i].filter.all[j].field")
$sOperator = $oJResp.StringOf("ola_policies[i].filter.all[j].operator")
$sValue = $oJResp.StringOf("ola_policies[i].filter.all[j].value")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("ola_policies[i].filter.any")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sField = $oJResp.StringOf("ola_policies[i].filter.any[j].field")
$sOperator = $oJResp.StringOf("ola_policies[i].filter.any[j].operator")
$sValue = $oJResp.StringOf("ola_policies[i].filter.any[j].value")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("ola_policies[i].policy_metrics")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sBusiness_hours = $oJResp.StringOf("ola_policies[i].policy_metrics[j].business_hours")
$sMetric = $oJResp.StringOf("ola_policies[i].policy_metrics[j].metric")
$sPriority = $oJResp.StringOf("ola_policies[i].policy_metrics[j].priority")
$sTarget = $oJResp.StringOf("ola_policies[i].policy_metrics[j].target")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
