Powershell / Support API / Filter Definitions
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/relationships/definitions/:target_type",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# 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
$v_Type = $jResp.StringOf("definitions.type")
$Conditions_allType = $jResp.StringOf("definitions.properties.conditions_all.type")
$ItemsType = $jResp.StringOf("definitions.properties.conditions_all.items.type")
$GroupType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.group.type")
$Default = $jResp.StringOf("definitions.properties.conditions_all.items.properties.group.default")
$NullableType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.type")
$NullableDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.default")
$OperatorsType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.type")
$ItemsType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.type")
$TerminalType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type")
$TerminalDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default")
$TitleType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.type")
$TitleDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.default")
$ValueType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.type")
$ValueDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.default")
$MaxItems = $jResp.IntOf("definitions.properties.conditions_all.items.properties.operators.maxItems")
$RepeatableType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.type")
$RepeatableDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.default")
$SubjectType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
$SubjectDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
$TitleType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
$TitleDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
$TypeType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.type.type")
$TypeDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.type.default")
$ValuesType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.type")
$ItemsType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.type")
$EnabledType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type")
$EnabledDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default")
$TitleType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.type")
$TitleDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.default")
$ValueType = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.type")
$ValueDefault = $jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.default")
$ValuesMaxItems = $jResp.IntOf("definitions.properties.conditions_all.items.properties.values.maxItems")
$Conditions_allMaxItems = $jResp.IntOf("definitions.properties.conditions_all.maxItems")
$Conditions_anyType = $jResp.StringOf("definitions.properties.conditions_any.type")
$ItemsType = $jResp.StringOf("definitions.properties.conditions_any.items.type")
$GroupType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.group.type")
$GroupDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.group.default")
$NullableType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.type")
$NullableDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.default")
$OperatorsType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.type")
$ItemsType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.type")
$TerminalType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type")
$TerminalDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default")
$TitleType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.type")
$TitleDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.default")
$ValueType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.type")
$ValueDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.default")
$OperatorsMaxItems = $jResp.IntOf("definitions.properties.conditions_any.items.properties.operators.maxItems")
$RepeatableType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.type")
$RepeatableDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.default")
$SubjectType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
$SubjectDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
$TitleType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
$TitleDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
$TypeType = $jResp.StringOf("definitions.properties.conditions_any.items.properties.type.type")
$TypeDefault = $jResp.StringOf("definitions.properties.conditions_any.items.properties.type.default")
$Conditions_anyMaxItems = $jResp.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}"
}
]
}
