autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sV_Type = $oJResp.StringOf("definitions.type")
Local $sAllType = $oJResp.StringOf("definitions.properties.all.type")
Local $sItemsType = $oJResp.StringOf("definitions.properties.all.items.type")
Local $sGroupType = $oJResp.StringOf("definitions.properties.all.items.properties.group.type")
Local $sDefault = $oJResp.StringOf("definitions.properties.all.items.properties.group.default")
Local $sOperatorsType = $oJResp.StringOf("definitions.properties.all.items.properties.operators.type")
$sItemsType = $oJResp.StringOf("definitions.properties.all.items.properties.operators.items.type")
Local $sTitleType = $oJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.type")
Local $sTitleDefault = $oJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.default")
Local $sValueType = $oJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.type")
Local $sValueDefault = $oJResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.default")
Local $iMaxItems = $oJResp.IntOf("definitions.properties.all.items.properties.operators.maxItems")
Local $sTargetType = $oJResp.StringOf("definitions.properties.all.items.properties.target.type")
Local $bNullable = $oJResp.BoolOf("definitions.properties.all.items.properties.target.nullable")
Local $sTargetDefault = $oJResp.StringOf("definitions.properties.all.items.properties.target.default")
$sTitleType = $oJResp.StringOf("definitions.properties.all.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.all.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.all.items.properties.value.type")
$sValueDefault = $oJResp.StringOf("definitions.properties.all.items.properties.value.default")
Local $sValuesType = $oJResp.StringOf("definitions.properties.all.items.properties.values.type")
Local $sListType = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.type")
$sItemsType = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.type")
$sTitleType = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.type")
Local $bValueNullable = $oJResp.BoolOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable")
$sValueDefault = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.default")
Local $iListMaxItems = $oJResp.IntOf("definitions.properties.all.items.properties.values.properties.list.maxItems")
Local $sTypeType = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.type.type")
Local $sTypeDefault = $oJResp.StringOf("definitions.properties.all.items.properties.values.properties.type.default")
Local $iAllMaxItems = $oJResp.IntOf("definitions.properties.all.maxItems")
Local $sAnyType = $oJResp.StringOf("definitions.properties.any.type")
$sItemsType = $oJResp.StringOf("definitions.properties.any.items.type")
$sGroupType = $oJResp.StringOf("definitions.properties.any.items.properties.group.type")
Local $sGroupDefault = $oJResp.StringOf("definitions.properties.any.items.properties.group.default")
$sOperatorsType = $oJResp.StringOf("definitions.properties.any.items.properties.operators.type")
$sItemsType = $oJResp.StringOf("definitions.properties.any.items.properties.operators.items.type")
$sTitleType = $oJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.type")
$sValueDefault = $oJResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.default")
Local $iOperatorsMaxItems = $oJResp.IntOf("definitions.properties.any.items.properties.operators.maxItems")
$sTargetType = $oJResp.StringOf("definitions.properties.any.items.properties.target.type")
Local $bTargetNullable = $oJResp.BoolOf("definitions.properties.any.items.properties.target.nullable")
$sTargetDefault = $oJResp.StringOf("definitions.properties.any.items.properties.target.default")
$sTitleType = $oJResp.StringOf("definitions.properties.any.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.any.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.any.items.properties.value.type")
$sValueDefault = $oJResp.StringOf("definitions.properties.any.items.properties.value.default")
$sValuesType = $oJResp.StringOf("definitions.properties.any.items.properties.values.type")
$sListType = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.type")
$sItemsType = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.type")
$sTitleType = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.type")
$bValueNullable = $oJResp.BoolOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable")
$sValueDefault = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.default")
$iListMaxItems = $oJResp.IntOf("definitions.properties.any.items.properties.values.properties.list.maxItems")
$sTypeType = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.type.type")
$sTypeDefault = $oJResp.StringOf("definitions.properties.any.items.properties.values.properties.type.default")
Local $iAnyMaxItems = $oJResp.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}"
}
]
}
