Foxpro / Support API / Filter Definitions
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcConditions_allType
LOCAL lcItemsType
LOCAL lcGroupType
LOCAL lcDefault
LOCAL lcNullableType
LOCAL lcNullableDefault
LOCAL lcOperatorsType
LOCAL lcTerminalType
LOCAL lcTerminalDefault
LOCAL lcTitleType
LOCAL lcTitleDefault
LOCAL lcValueType
LOCAL lcValueDefault
LOCAL lnMaxItems
LOCAL lcRepeatableType
LOCAL lcRepeatableDefault
LOCAL lcSubjectType
LOCAL lcSubjectDefault
LOCAL lcTypeType
LOCAL lcTypeDefault
LOCAL lcValuesType
LOCAL lcEnabledType
LOCAL lcEnabledDefault
LOCAL lnValuesMaxItems
LOCAL lnConditions_allMaxItems
LOCAL lcConditions_anyType
LOCAL lcGroupDefault
LOCAL lnOperatorsMaxItems
LOCAL lnConditions_anyMaxItems
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/relationships/definitions/:target_type",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcV_Type = loJResp.StringOf("definitions.type")
lcConditions_allType = loJResp.StringOf("definitions.properties.conditions_all.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_all.items.type")
lcGroupType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.group.type")
lcDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.group.default")
lcNullableType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.type")
lcNullableDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.default")
lcOperatorsType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.type")
lcTerminalType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type")
lcTerminalDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.default")
lnMaxItems = loJResp.IntOf("definitions.properties.conditions_all.items.properties.operators.maxItems")
lcRepeatableType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.type")
lcRepeatableDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.default")
lcSubjectType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
lcSubjectDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
lcTypeType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.type.type")
lcTypeDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.type.default")
lcValuesType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.type")
lcEnabledType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type")
lcEnabledDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.default")
lnValuesMaxItems = loJResp.IntOf("definitions.properties.conditions_all.items.properties.values.maxItems")
lnConditions_allMaxItems = loJResp.IntOf("definitions.properties.conditions_all.maxItems")
lcConditions_anyType = loJResp.StringOf("definitions.properties.conditions_any.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_any.items.type")
lcGroupType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.group.type")
lcGroupDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.group.default")
lcNullableType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.type")
lcNullableDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.default")
lcOperatorsType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.type")
lcTerminalType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type")
lcTerminalDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.default")
lcValueType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.type")
lcValueDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.default")
lnOperatorsMaxItems = loJResp.IntOf("definitions.properties.conditions_any.items.properties.operators.maxItems")
lcRepeatableType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.type")
lcRepeatableDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.default")
lcSubjectType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
lcSubjectDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
lcTypeType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.type.type")
lcTypeDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.type.default")
lnConditions_anyMaxItems = loJResp.IntOf("definitions.properties.conditions_any.maxItems")
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
