Xojo / Support API / Show OLA Policy
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.BasicAuth = True
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/:ola_policy_id",sbResponseBody)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(http.LastHeader)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "ola_policy": {
// "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>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim field As String
Dim operator As String
Dim value As String
Dim business_hours As String
Dim metric As String
Dim priority As String
Dim target As String
Dim Title As String
Title = jResp.StringOf("ola_policy.title")
Dim Created_at As String
Created_at = jResp.StringOf("ola_policy.created_at")
Dim Description As String
Description = jResp.StringOf("ola_policy.description")
Dim Id As String
Id = jResp.StringOf("ola_policy.id")
Dim Position As String
Position = jResp.StringOf("ola_policy.position")
Dim Updated_at As String
Updated_at = jResp.StringOf("ola_policy.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("ola_policy.url")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("ola_policy.filter.all")
While i < count_i
jResp.I = i
field = jResp.StringOf("ola_policy.filter.all[i].field")
operator = jResp.StringOf("ola_policy.filter.all[i].operator")
value = jResp.StringOf("ola_policy.filter.all[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("ola_policy.filter.any")
While i < count_i
jResp.I = i
field = jResp.StringOf("ola_policy.filter.any[i].field")
operator = jResp.StringOf("ola_policy.filter.any[i].operator")
value = jResp.StringOf("ola_policy.filter.any[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("ola_policy.policy_metrics")
While i < count_i
jResp.I = i
business_hours = jResp.StringOf("ola_policy.policy_metrics[i].business_hours")
metric = jResp.StringOf("ola_policy.policy_metrics[i].metric")
priority = jResp.StringOf("ola_policy.policy_metrics[i].priority")
target = jResp.StringOf("ola_policy.policy_metrics[i].target")
i = i + 1
Wend
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies/:ola_policy_id
Postman Collection Item JSON
{
"name": "Show OLA Policy",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies/:ola_policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
":ola_policy_id"
],
"variable": [
{
"key": "ola_policy_id",
"value": "<integer>"
}
]
},
"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/:ola_policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
":ola_policy_id"
],
"variable": [
{
"key": "ola_policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ola_policy\": {\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}"
}
]
}
