DataFlex / Support API / Filter Definitions
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_Type
String sConditions_allType
String sItemsType
String sGroupType
String sDefault
String sNullableType
String sNullableDefault
String sOperatorsType
String sTerminalType
String sTerminalDefault
String sTitleType
String sTitleDefault
String sValueType
String sValueDefault
Integer iMaxItems
String sRepeatableType
String sRepeatableDefault
String sSubjectType
String sSubjectDefault
String sTypeType
String sTypeDefault
String sValuesType
String sEnabledType
String sEnabledDefault
Integer iValuesMaxItems
Integer iConditions_allMaxItems
String sConditions_anyType
String sGroupDefault
Integer iOperatorsMaxItems
Integer iConditions_anyMaxItems
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://example.zendesk.com/api/v2/relationships/definitions/:target_type" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "definitions.type" To sV_Type
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.type" To sConditions_allType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.type" To sItemsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.group.type" To sGroupType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.group.default" To sDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.nullable.type" To sNullableType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.nullable.default" To sNullableDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.type" To sOperatorsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.type" To sItemsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type" To sTerminalType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default" To sTerminalDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.title.type" To sTitleType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.title.default" To sTitleDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.value.type" To sValueType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.items.properties.value.default" To sValueDefault
Get ComIntOf Of hoJResp "definitions.properties.conditions_all.items.properties.operators.maxItems" To iMaxItems
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.repeatable.type" To sRepeatableType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.repeatable.default" To sRepeatableDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.subject.type" To sSubjectType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.subject.default" To sSubjectDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.title.type" To sTitleType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.title.default" To sTitleDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.type.type" To sTypeType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.type.default" To sTypeDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.type" To sValuesType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.type" To sItemsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type" To sEnabledType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default" To sEnabledDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.title.type" To sTitleType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.title.default" To sTitleDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.value.type" To sValueType
Get ComStringOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.items.properties.value.default" To sValueDefault
Get ComIntOf Of hoJResp "definitions.properties.conditions_all.items.properties.values.maxItems" To iValuesMaxItems
Get ComIntOf Of hoJResp "definitions.properties.conditions_all.maxItems" To iConditions_allMaxItems
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.type" To sConditions_anyType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.type" To sItemsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.group.type" To sGroupType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.group.default" To sGroupDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.nullable.type" To sNullableType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.nullable.default" To sNullableDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.type" To sOperatorsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.type" To sItemsType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type" To sTerminalType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default" To sTerminalDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.title.type" To sTitleType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.title.default" To sTitleDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.value.type" To sValueType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.items.properties.value.default" To sValueDefault
Get ComIntOf Of hoJResp "definitions.properties.conditions_any.items.properties.operators.maxItems" To iOperatorsMaxItems
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.repeatable.type" To sRepeatableType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.repeatable.default" To sRepeatableDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.subject.type" To sSubjectType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.subject.default" To sSubjectDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.title.type" To sTitleType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.title.default" To sTitleDefault
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.type.type" To sTypeType
Get ComStringOf Of hoJResp "definitions.properties.conditions_any.items.properties.type.default" To sTypeDefault
Get ComIntOf Of hoJResp "definitions.properties.conditions_any.maxItems" To iConditions_anyMaxItems
End_Procedure
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}"
}
]
}
