Go / Support API / Retrieve Supported Filter Definition Items
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global_Ref.html">Global Unlock Sample for sample code.
http := chilkat.NewHttp()
var success bool
http.SetBasicAuth(true)
http.SetLogin("login")
http.SetPassword("password")
http.SetRequestHeader("Accept","application/json")
sbResponseBody := chilkat.NewStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/slas/policies/definitions",sbResponseBody)
if success == false {
fmt.Println(http.LastErrorText())
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
return
}
jResp := chilkat.NewJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.SetEmitCompact(false)
fmt.Println("Response Body:")
fmt.Println(*jResp.Emit())
respStatusCode := http.LastStatus()
fmt.Println("Response Status Code = ", respStatusCode)
if respStatusCode >= 400 {
fmt.Println("Response Header:")
fmt.Println(http.LastHeader())
fmt.Println("Failed.")
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
return
}
// 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
v_Type := jResp.StringOf("definitions.type")
AllType := jResp.StringOf("definitions.properties.all.type")
ItemsType := jResp.StringOf("definitions.properties.all.items.type")
GroupType := jResp.StringOf("definitions.properties.all.items.properties.group.type")
Default := jResp.StringOf("definitions.properties.all.items.properties.group.default")
OperatorsType := jResp.StringOf("definitions.properties.all.items.properties.operators.type")
ItemsType = jResp.StringOf("definitions.properties.all.items.properties.operators.items.type")
TitleType := jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.type")
TitleDefault := jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.default")
ValueType := jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.type")
ValueDefault := jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.default")
MaxItems := jResp.IntOf("definitions.properties.all.items.properties.operators.maxItems")
TargetType := jResp.StringOf("definitions.properties.all.items.properties.target.type")
Nullable := jResp.BoolOf("definitions.properties.all.items.properties.target.nullable")
TargetDefault := jResp.StringOf("definitions.properties.all.items.properties.target.default")
TitleType = jResp.StringOf("definitions.properties.all.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.all.items.properties.title.default")
ValueType = jResp.StringOf("definitions.properties.all.items.properties.value.type")
ValueDefault = jResp.StringOf("definitions.properties.all.items.properties.value.default")
ValuesType := jResp.StringOf("definitions.properties.all.items.properties.values.type")
ListType := jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.type")
ItemsType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.type")
TitleType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.default")
ValueType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.type")
ValueNullable := jResp.BoolOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable")
ValueDefault = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.default")
ListMaxItems := jResp.IntOf("definitions.properties.all.items.properties.values.properties.list.maxItems")
TypeType := jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.type")
TypeDefault := jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.default")
AllMaxItems := jResp.IntOf("definitions.properties.all.maxItems")
AnyType := jResp.StringOf("definitions.properties.any.type")
ItemsType = jResp.StringOf("definitions.properties.any.items.type")
GroupType = jResp.StringOf("definitions.properties.any.items.properties.group.type")
GroupDefault := jResp.StringOf("definitions.properties.any.items.properties.group.default")
OperatorsType = jResp.StringOf("definitions.properties.any.items.properties.operators.type")
ItemsType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.type")
TitleType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.default")
ValueType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.type")
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.default")
OperatorsMaxItems := jResp.IntOf("definitions.properties.any.items.properties.operators.maxItems")
TargetType = jResp.StringOf("definitions.properties.any.items.properties.target.type")
TargetNullable := jResp.BoolOf("definitions.properties.any.items.properties.target.nullable")
TargetDefault = jResp.StringOf("definitions.properties.any.items.properties.target.default")
TitleType = jResp.StringOf("definitions.properties.any.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.title.default")
ValueType = jResp.StringOf("definitions.properties.any.items.properties.value.type")
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.value.default")
ValuesType = jResp.StringOf("definitions.properties.any.items.properties.values.type")
ListType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.type")
ItemsType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.type")
TitleType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.type")
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.default")
ValueType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.type")
ValueNullable = jResp.BoolOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable")
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.default")
ListMaxItems = jResp.IntOf("definitions.properties.any.items.properties.values.properties.list.maxItems")
TypeType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.type.type")
TypeDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.type.default")
AnyMaxItems := jResp.IntOf("definitions.properties.any.maxItems")
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
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}"
}
]
}
