Chilkat Online Tools

VB.NET / Support API / Retrieve Supported Filter Definition Items

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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




Dim v_Type As String = jResp.StringOf("definitions.type")
Dim AllType As String = jResp.StringOf("definitions.properties.all.type")
Dim ItemsType As String = jResp.StringOf("definitions.properties.all.items.type")
Dim GroupType As String = jResp.StringOf("definitions.properties.all.items.properties.group.type")
Dim Default As String = jResp.StringOf("definitions.properties.all.items.properties.group.default")
Dim OperatorsType As String = jResp.StringOf("definitions.properties.all.items.properties.operators.type")
ItemsType = jResp.StringOf("definitions.properties.all.items.properties.operators.items.type")
Dim TitleType As String = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.type")
Dim TitleDefault As String = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.default")
Dim ValueType As String = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.type")
Dim ValueDefault As String = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.default")
Dim MaxItems As Integer = jResp.IntOf("definitions.properties.all.items.properties.operators.maxItems")
Dim TargetType As String = jResp.StringOf("definitions.properties.all.items.properties.target.type")
Dim Nullable As Boolean = jResp.BoolOf("definitions.properties.all.items.properties.target.nullable")
Dim TargetDefault As String = 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")
Dim ValuesType As String = jResp.StringOf("definitions.properties.all.items.properties.values.type")
Dim ListType As String = 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")
Dim ValueNullable As Boolean = 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")
Dim ListMaxItems As Integer = jResp.IntOf("definitions.properties.all.items.properties.values.properties.list.maxItems")
Dim TypeType As String = jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.type")
Dim TypeDefault As String = jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.default")
Dim AllMaxItems As Integer = jResp.IntOf("definitions.properties.all.maxItems")
Dim AnyType As String = jResp.StringOf("definitions.properties.any.type")
ItemsType = jResp.StringOf("definitions.properties.any.items.type")
GroupType = jResp.StringOf("definitions.properties.any.items.properties.group.type")
Dim GroupDefault As String = 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")
Dim OperatorsMaxItems As Integer = jResp.IntOf("definitions.properties.any.items.properties.operators.maxItems")
TargetType = jResp.StringOf("definitions.properties.any.items.properties.target.type")
Dim TargetNullable As Boolean = 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")
Dim AnyMaxItems As Integer = jResp.IntOf("definitions.properties.any.maxItems")

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}"
    }
  ]
}