autoit / Support API / Filter Definitions
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/relationships/definitions/:target_type",$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": {
; "conditions_all": {
; "type": "array",
; "items": {
; "type": "object",
; "properties": {
; "group": {
; "type": "string",
; "default": "<string>"
; },
; "nullable": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "operators": {
; "type": "array",
; "items": {
; "type": "object",
; "properties": {
; "terminal": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "title": {
; "type": "string",
; "default": "<string>"
; },
; "value": {
; "type": "string",
; "default": "<string>"
; }
; }
; },
; "maxItems": 2
; },
; "repeatable": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "subject": {
; "type": "string",
; "default": "<string>"
; },
; "title": {
; "type": "string",
; "default": "<string>"
; },
; "type": {
; "type": "string",
; "default": "<string>"
; },
; "values": {
; "type": "array",
; "items": {
; "type": "object",
; "properties": {
; "enabled": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "title": {
; "type": "string",
; "default": "<string>"
; },
; "value": {
; "type": "string",
; "default": "<string>"
; }
; }
; },
; "maxItems": 2
; }
; }
; },
; "maxItems": 2
; },
; "conditions_any": {
; "type": "array",
; "items": {
; "type": "object",
; "properties": {
; "group": {
; "type": "string",
; "default": "<string>"
; },
; "nullable": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "operators": {
; "type": "array",
; "items": {
; "type": "object",
; "properties": {
; "terminal": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "title": {
; "type": "string",
; "default": "<string>"
; },
; "value": {
; "type": "string",
; "default": "<string>"
; }
; }
; },
; "maxItems": 2
; },
; "repeatable": {
; "type": "boolean",
; "default": "<boolean>"
; },
; "subject": {
; "type": "string",
; "default": "<string>"
; },
; "title": {
; "type": "string",
; "default": "<string>"
; },
; "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 $sConditions_allType = $oJResp.StringOf("definitions.properties.conditions_all.type")
Local $sItemsType = $oJResp.StringOf("definitions.properties.conditions_all.items.type")
Local $sGroupType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.group.type")
Local $sDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.group.default")
Local $sNullableType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.type")
Local $sNullableDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.default")
Local $sOperatorsType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.type")
$sItemsType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.type")
Local $sTerminalType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type")
Local $sTerminalDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default")
Local $sTitleType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.type")
Local $sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.default")
Local $sValueType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.type")
Local $sValueDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.default")
Local $iMaxItems = $oJResp.IntOf("definitions.properties.conditions_all.items.properties.operators.maxItems")
Local $sRepeatableType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.type")
Local $sRepeatableDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.default")
Local $sSubjectType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
Local $sSubjectDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
$sTitleType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
Local $sTypeType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.type.type")
Local $sTypeDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.type.default")
Local $sValuesType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.type")
$sItemsType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.type")
Local $sEnabledType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type")
Local $sEnabledDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default")
$sTitleType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.type")
$sValueDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.default")
Local $iValuesMaxItems = $oJResp.IntOf("definitions.properties.conditions_all.items.properties.values.maxItems")
Local $iConditions_allMaxItems = $oJResp.IntOf("definitions.properties.conditions_all.maxItems")
Local $sConditions_anyType = $oJResp.StringOf("definitions.properties.conditions_any.type")
$sItemsType = $oJResp.StringOf("definitions.properties.conditions_any.items.type")
$sGroupType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.group.type")
Local $sGroupDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.group.default")
$sNullableType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.type")
$sNullableDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.default")
$sOperatorsType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.type")
$sItemsType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.type")
$sTerminalType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type")
$sTerminalDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default")
$sTitleType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.default")
$sValueType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.type")
$sValueDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.default")
Local $iOperatorsMaxItems = $oJResp.IntOf("definitions.properties.conditions_any.items.properties.operators.maxItems")
$sRepeatableType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.type")
$sRepeatableDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.default")
$sSubjectType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
$sSubjectDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
$sTitleType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
$sTypeType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.type.type")
$sTypeDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.type.default")
Local $iConditions_anyMaxItems = $oJResp.IntOf("definitions.properties.conditions_any.maxItems")
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/relationships/definitions/:target_type
Postman Collection Item JSON
{
"name": "Filter Definitions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/relationships/definitions/:target_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"relationships",
"definitions",
":target_type"
],
"variable": [
{
"key": "target_type",
"value": "<string>"
}
]
},
"description": "Returns filter definitions based on the given target type. Target types\ninclude users (zen:user), tickets (zen:ticket), organizations (zen:organization), or custom objects (zen:custom_object:CUSTOM_OBJECT_KEY).\nThe returned filter definitions are the options that you can use to build a custom field or ticket field's\n`relationship_filter`.\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/relationships/definitions/:target_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"relationships",
"definitions",
":target_type"
],
"variable": [
{
"key": "target_type"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"conditions_all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 }\n },\n \"maxItems\": 2\n },\n \"conditions_any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\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 \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}
