Swift3 / Support API / Retrieve Supported Filter Definition Items
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
http.setRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
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
var v_Type: String? = jResp.string(of: "definitions.type")
var AllType: String? = jResp.string(of: "definitions.properties.all.type")
var ItemsType: String? = jResp.string(of: "definitions.properties.all.items.type")
var GroupType: String? = jResp.string(of: "definitions.properties.all.items.properties.group.type")
var Default: String? = jResp.string(of: "definitions.properties.all.items.properties.group.default")
var OperatorsType: String? = jResp.string(of: "definitions.properties.all.items.properties.operators.type")
ItemsType = jResp.string(of: "definitions.properties.all.items.properties.operators.items.type")
var TitleType: String? = jResp.string(of: "definitions.properties.all.items.properties.operators.items.properties.title.type")
var TitleDefault: String? = jResp.string(of: "definitions.properties.all.items.properties.operators.items.properties.title.default")
var ValueType: String? = jResp.string(of: "definitions.properties.all.items.properties.operators.items.properties.value.type")
var ValueDefault: String? = jResp.string(of: "definitions.properties.all.items.properties.operators.items.properties.value.default")
var MaxItems: Int = jResp.int(of: "definitions.properties.all.items.properties.operators.maxItems").intValue
var TargetType: String? = jResp.string(of: "definitions.properties.all.items.properties.target.type")
var Nullable: Bool = jResp.bool(of: "definitions.properties.all.items.properties.target.nullable")
var TargetDefault: String? = jResp.string(of: "definitions.properties.all.items.properties.target.default")
TitleType = jResp.string(of: "definitions.properties.all.items.properties.title.type")
TitleDefault = jResp.string(of: "definitions.properties.all.items.properties.title.default")
ValueType = jResp.string(of: "definitions.properties.all.items.properties.value.type")
ValueDefault = jResp.string(of: "definitions.properties.all.items.properties.value.default")
var ValuesType: String? = jResp.string(of: "definitions.properties.all.items.properties.values.type")
var ListType: String? = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.type")
ItemsType = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.items.type")
TitleType = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.items.properties.title.type")
TitleDefault = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.items.properties.title.default")
ValueType = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.items.properties.value.type")
var ValueNullable: Bool = jResp.bool(of: "definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable")
ValueDefault = jResp.string(of: "definitions.properties.all.items.properties.values.properties.list.items.properties.value.default")
var ListMaxItems: Int = jResp.int(of: "definitions.properties.all.items.properties.values.properties.list.maxItems").intValue
var TypeType: String? = jResp.string(of: "definitions.properties.all.items.properties.values.properties.type.type")
var TypeDefault: String? = jResp.string(of: "definitions.properties.all.items.properties.values.properties.type.default")
var AllMaxItems: Int = jResp.int(of: "definitions.properties.all.maxItems").intValue
var AnyType: String? = jResp.string(of: "definitions.properties.any.type")
ItemsType = jResp.string(of: "definitions.properties.any.items.type")
GroupType = jResp.string(of: "definitions.properties.any.items.properties.group.type")
var GroupDefault: String? = jResp.string(of: "definitions.properties.any.items.properties.group.default")
OperatorsType = jResp.string(of: "definitions.properties.any.items.properties.operators.type")
ItemsType = jResp.string(of: "definitions.properties.any.items.properties.operators.items.type")
TitleType = jResp.string(of: "definitions.properties.any.items.properties.operators.items.properties.title.type")
TitleDefault = jResp.string(of: "definitions.properties.any.items.properties.operators.items.properties.title.default")
ValueType = jResp.string(of: "definitions.properties.any.items.properties.operators.items.properties.value.type")
ValueDefault = jResp.string(of: "definitions.properties.any.items.properties.operators.items.properties.value.default")
var OperatorsMaxItems: Int = jResp.int(of: "definitions.properties.any.items.properties.operators.maxItems").intValue
TargetType = jResp.string(of: "definitions.properties.any.items.properties.target.type")
var TargetNullable: Bool = jResp.bool(of: "definitions.properties.any.items.properties.target.nullable")
TargetDefault = jResp.string(of: "definitions.properties.any.items.properties.target.default")
TitleType = jResp.string(of: "definitions.properties.any.items.properties.title.type")
TitleDefault = jResp.string(of: "definitions.properties.any.items.properties.title.default")
ValueType = jResp.string(of: "definitions.properties.any.items.properties.value.type")
ValueDefault = jResp.string(of: "definitions.properties.any.items.properties.value.default")
ValuesType = jResp.string(of: "definitions.properties.any.items.properties.values.type")
ListType = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.type")
ItemsType = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.items.type")
TitleType = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.items.properties.title.type")
TitleDefault = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.items.properties.title.default")
ValueType = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.items.properties.value.type")
ValueNullable = jResp.bool(of: "definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable")
ValueDefault = jResp.string(of: "definitions.properties.any.items.properties.values.properties.list.items.properties.value.default")
ListMaxItems = jResp.int(of: "definitions.properties.any.items.properties.values.properties.list.maxItems").intValue
TypeType = jResp.string(of: "definitions.properties.any.items.properties.values.properties.type.type")
TypeDefault = jResp.string(of: "definitions.properties.any.items.properties.values.properties.type.default")
var AnyMaxItems: Int = jResp.int(of: "definitions.properties.any.maxItems").intValue
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/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/olas/policies/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
"definitions"
]
},
"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/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"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}"
}
]
}
