Chilkat Online Tools

Python / Support API / List OLA Policies

Back to Collection Items

import sys
import chilkat

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat.CkHttp()

http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.lastHeader())
    print("Failed.")
    sys.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

count = jResp.stringOf("count")
next_page = jResp.stringOf("next_page")
previous_page = jResp.stringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("ola_policies")
while i < count_i :
    jResp.put_I(i)
    title = jResp.stringOf("ola_policies[i].title")
    created_at = jResp.stringOf("ola_policies[i].created_at")
    description = jResp.stringOf("ola_policies[i].description")
    id = jResp.stringOf("ola_policies[i].id")
    position = jResp.stringOf("ola_policies[i].position")
    updated_at = jResp.stringOf("ola_policies[i].updated_at")
    url = jResp.stringOf("ola_policies[i].url")
    j = 0
    count_j = jResp.SizeOfArray("ola_policies[i].filter.all")
    while j < count_j :
        jResp.put_J(j)
        field = jResp.stringOf("ola_policies[i].filter.all[j].field")
        operator = jResp.stringOf("ola_policies[i].filter.all[j].operator")
        value = jResp.stringOf("ola_policies[i].filter.all[j].value")
        j = j + 1

    j = 0
    count_j = jResp.SizeOfArray("ola_policies[i].filter.any")
    while j < count_j :
        jResp.put_J(j)
        field = jResp.stringOf("ola_policies[i].filter.any[j].field")
        operator = jResp.stringOf("ola_policies[i].filter.any[j].operator")
        value = jResp.stringOf("ola_policies[i].filter.any[j].value")
        j = j + 1

    j = 0
    count_j = jResp.SizeOfArray("ola_policies[i].policy_metrics")
    while j < count_j :
        jResp.put_J(j)
        business_hours = jResp.stringOf("ola_policies[i].policy_metrics[j].business_hours")
        metric = jResp.stringOf("ola_policies[i].policy_metrics[j].metric")
        priority = jResp.stringOf("ola_policies[i].policy_metrics[j].priority")
        target = jResp.stringOf("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}"
    }
  ]
}