TCL / Support API / Retrieve Supported Filter Definition Items
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"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/slas/policies/definitions" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "definitions": {
# "type": "object",
# "properties": {
# "all": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "group": {
# "type": "string",
# "default": "<string>"
# },
# "operators": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "target": {
# "type": "string",
# "nullable": true,
# "default": "<string>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# },
# "values": {
# "type": "object",
# "properties": {
# "list": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "nullable": true,
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "type": {
# "type": "string",
# "default": "<string>"
# }
# }
# }
# }
# },
# "maxItems": 2
# },
# "any": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "group": {
# "type": "string",
# "default": "<string>"
# },
# "operators": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "target": {
# "type": "string",
# "nullable": true,
# "default": "<string>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# },
# "values": {
# "type": "object",
# "properties": {
# "list": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "nullable": true,
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "type": {
# "type": "string",
# "default": "<string>"
# }
# }
# }
# }
# },
# "maxItems": 2
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set v_Type [CkJsonObject_stringOf $jResp "definitions.type"]
set AllType [CkJsonObject_stringOf $jResp "definitions.properties.all.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.type"]
set GroupType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.group.type"]
set Default [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.group.default"]
set OperatorsType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.items.type"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.operators.items.properties.value.default"]
set MaxItems [CkJsonObject_IntOf $jResp "definitions.properties.all.items.properties.operators.maxItems"]
set TargetType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.target.type"]
set Nullable [CkJsonObject_BoolOf $jResp "definitions.properties.all.items.properties.target.nullable"]
set TargetDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.target.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.value.default"]
set ValuesType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.type"]
set ListType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.type"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.properties.value.type"]
set ValueNullable [CkJsonObject_BoolOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.list.items.properties.value.default"]
set ListMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.all.items.properties.values.properties.list.maxItems"]
set TypeType [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.type.type"]
set TypeDefault [CkJsonObject_stringOf $jResp "definitions.properties.all.items.properties.values.properties.type.default"]
set AllMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.all.maxItems"]
set AnyType [CkJsonObject_stringOf $jResp "definitions.properties.any.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.type"]
set GroupType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.group.type"]
set GroupDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.group.default"]
set OperatorsType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.items.type"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.operators.items.properties.value.default"]
set OperatorsMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.any.items.properties.operators.maxItems"]
set TargetType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.target.type"]
set TargetNullable [CkJsonObject_BoolOf $jResp "definitions.properties.any.items.properties.target.nullable"]
set TargetDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.target.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.value.default"]
set ValuesType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.type"]
set ListType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.type"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.properties.value.type"]
set ValueNullable [CkJsonObject_BoolOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.list.items.properties.value.default"]
set ListMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.any.items.properties.values.properties.list.maxItems"]
set TypeType [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.type.type"]
set TypeDefault [CkJsonObject_stringOf $jResp "definitions.properties.any.items.properties.values.properties.type.default"]
set AnyMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.any.maxItems"]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/slas/policies/definitions
Postman Collection Item JSON
{
"name": "Retrieve Supported Filter Definition Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/slas/policies/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"slas",
"policies",
"definitions"
]
},
"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/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"slas",
"policies",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"target\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"object\",\n \"properties\": {\n \"list\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n }\n }\n },\n \"maxItems\": 2\n },\n \"any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"target\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"object\",\n \"properties\": {\n \"list\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}
