Delphi (DLL) / Support API / Filter Definitions
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/relationships/definitions/:target_type',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.operators.items.type');TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.title.type');TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.title.default');ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.values.items.type');TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.values.items.properties.title.type');TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.values.items.properties.title.default');ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.values.items.properties.value.type');ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_all.items.properties.values.items.properties.value.default');ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.type');GroupType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.group.type');NullableType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.nullable.type');NullableDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.nullable.default');OperatorsType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.type');ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.type');TerminalType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type');TerminalDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default');TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.title.type');TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.title.default');ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.value.type');ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.operators.items.properties.value.default');RepeatableType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.repeatable.type');RepeatableDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.repeatable.default');SubjectType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.subject.type');SubjectDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.subject.default');TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.title.type');TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.title.default');TypeType := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.type.type');TypeDefault := CkJsonObject__stringOf(jResp,'definitions.properties.conditions_any.items.properties.type.default');
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}"
}
]
}
