Chilkat Online Tools

Python / Support API / Create OLA Policy

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

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

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/olas/policies")
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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

Title = jResp.StringOf("ola_policy.title")
Created_at = jResp.StringOf("ola_policy.created_at")
Description = jResp.StringOf("ola_policy.description")
Id = jResp.StringOf("ola_policy.id")
Position = jResp.StringOf("ola_policy.position")
Updated_at = jResp.StringOf("ola_policy.updated_at")
v_Url = jResp.StringOf("ola_policy.url")
i = 0
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

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

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

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies

Postman Collection Item JSON

{
  "name": "Create OLA Policy",
  "request": {
    "method": "POST",
    "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": "Created response",
      "originalRequest": {
        "method": "POST",
        "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": "Created",
      "code": 201,
      "_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}"
    }
  ]
}