Chilkat Online Tools

TCL / Support API / Create SLA Policy

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "POST" "https://example.zendesk.com/api/v2/slas/policies"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "sla_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

set Title [CkJsonObject_stringOf $jResp "sla_policy.title"]
set Created_at [CkJsonObject_stringOf $jResp "sla_policy.created_at"]
set Description [CkJsonObject_stringOf $jResp "sla_policy.description"]
set Id [CkJsonObject_stringOf $jResp "sla_policy.id"]
set Position [CkJsonObject_stringOf $jResp "sla_policy.position"]
set Updated_at [CkJsonObject_stringOf $jResp "sla_policy.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "sla_policy.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "sla_policy.filter.all"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set field [CkJsonObject_stringOf $jResp "sla_policy.filter.all[i].field"]
    set operator [CkJsonObject_stringOf $jResp "sla_policy.filter.all[i].operator"]
    set value [CkJsonObject_stringOf $jResp "sla_policy.filter.all[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "sla_policy.filter.any"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set field [CkJsonObject_stringOf $jResp "sla_policy.filter.any[i].field"]
    set operator [CkJsonObject_stringOf $jResp "sla_policy.filter.any[i].operator"]
    set value [CkJsonObject_stringOf $jResp "sla_policy.filter.any[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "sla_policy.policy_metrics"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set business_hours [CkJsonObject_stringOf $jResp "sla_policy.policy_metrics[i].business_hours"]
    set metric [CkJsonObject_stringOf $jResp "sla_policy.policy_metrics[i].metric"]
    set priority [CkJsonObject_stringOf $jResp "sla_policy.policy_metrics[i].priority"]
    set target [CkJsonObject_stringOf $jResp "sla_policy.policy_metrics[i].target"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create SLA Policy",
  "request": {
    "method": "POST",
    "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": "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/slas/policies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "slas",
            "policies"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sla_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}"
    }
  ]
}