Powershell / Support API / List SLA Policies
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/slas/policies",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>",
# "sla_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>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$count = $jResp.StringOf("count")
$next_page = $jResp.StringOf("next_page")
$previous_page = $jResp.StringOf("previous_page")
$i = 0
$count_i = $jResp.SizeOfArray("sla_policies")
while ($i -lt $count_i) {
$jResp.I = $i
$title = $jResp.StringOf("sla_policies[i].title")
$created_at = $jResp.StringOf("sla_policies[i].created_at")
$description = $jResp.StringOf("sla_policies[i].description")
$id = $jResp.StringOf("sla_policies[i].id")
$position = $jResp.StringOf("sla_policies[i].position")
$updated_at = $jResp.StringOf("sla_policies[i].updated_at")
$url = $jResp.StringOf("sla_policies[i].url")
$j = 0
$count_j = $jResp.SizeOfArray("sla_policies[i].filter.all")
while ($j -lt $count_j) {
$jResp.J = $j
$field = $jResp.StringOf("sla_policies[i].filter.all[j].field")
$operator = $jResp.StringOf("sla_policies[i].filter.all[j].operator")
$value = $jResp.StringOf("sla_policies[i].filter.all[j].value")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("sla_policies[i].filter.any")
while ($j -lt $count_j) {
$jResp.J = $j
$field = $jResp.StringOf("sla_policies[i].filter.any[j].field")
$operator = $jResp.StringOf("sla_policies[i].filter.any[j].operator")
$value = $jResp.StringOf("sla_policies[i].filter.any[j].value")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("sla_policies[i].policy_metrics")
while ($j -lt $count_j) {
$jResp.J = $j
$business_hours = $jResp.StringOf("sla_policies[i].policy_metrics[j].business_hours")
$metric = $jResp.StringOf("sla_policies[i].policy_metrics[j].metric")
$priority = $jResp.StringOf("sla_policies[i].policy_metrics[j].priority")
$target = $jResp.StringOf("sla_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/slas/policies
Postman Collection Item JSON
{
"name": "List SLA Policies",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/slas/policies",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"slas",
"policies"
]
},
"description": "#### Availability\n\n* Accounts on the Support Professional or Suite Growth plan or above\n\n#### 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/slas/policies",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"slas",
"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 \"previous_page\": \"<string>\",\n \"sla_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}"
}
]
}
