Filter Definitions

GET {{baseUrl}}/api/v2/relationships/definitions/:target_type

Returns filter definitions based on the given target type. Target types include users (zen:user), tickets (zen:ticket), or organizations (zen:organization). The returned filter definitions are the options that you can use to build a custom field or ticket field's relationship_filter.

HEADERS

RESPONSES

status: OK

{"definitions":{"conditions_all":[{"group":"ticket","nullable":false,"operators":[{"terminal":false,"title":"Is","value":"is"},{"terminal":false,"title":"Is not","value":"is_not"},{"terminal":false,"title":"Less than","value":"less_than"},{"terminal":false,"title":"Greater than","value":"greater_than"},{"terminal":true,"title":"Changed","value":"changed"},{"terminal":false,"title":"Changed to","value":"value"},{"terminal":false,"title":"Changed from","value":"value_previous"},{"terminal":true,"title":"Not changed","value":"not_changed"},{"terminal":false,"title":"Not changed to","value":"not_value"},{"terminal":false,"title":"Not changed from","value":"not_value_previous"}],"repeatable":false,"subject":"status","title":"Status","type":"list","values":[{"enabled":true,"title":"New","value":"new"},{"enabled":true,"title":"Open","value":"open"},{"enabled":true,"title":"Pending","value":"pending"},{"enabled":true,"title":"Solved","value":"solved"},{"enabled":true,"title":"Closed","value":"closed"}]}],"conditions_any":[{"group":"ticket","nullable":true,"operators":[{"terminal":true,"title":"Present","value":"present"},{"terminal":true,"title":"Not present","value":"not_present"}],"repeatable":false,"subject":"custom_fields_20513432","title":"Happy Gilmore","type":"list"},{"group":"ticket","nullable":true,"operators":[{"terminal":true,"title":"Present","value":"present"},{"terminal":true,"title":"Not present","value":"not_present"}],"repeatable":false,"subject":"custom_fields_86492341","title":"total_time_field","type":"list"}]}}