PureBasic / Support API / Filter Definitions
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/relationships/definitions/:target_type",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
v_Type.s = CkJsonObject::ckStringOf(jResp,"definitions.type")
Conditions_allType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.type")
ItemsType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.type")
GroupType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.group.type")
Default.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.group.default")
NullableType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.nullable.type")
NullableDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.nullable.default")
OperatorsType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.type")
ItemsType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.type")
TerminalType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type")
TerminalDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default")
TitleType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.title.type")
TitleDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.title.default")
ValueType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.value.type")
ValueDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.value.default")
MaxItems.i = CkJsonObject::ckIntOf(jResp,"definitions.properties.conditions_all.items.properties.operators.maxItems")
RepeatableType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.repeatable.type")
RepeatableDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.repeatable.default")
SubjectType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.type")
SubjectDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.default")
TitleType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.title.type")
TitleDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.title.default")
TypeType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.type.type")
TypeDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.type.default")
ValuesType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.type")
ItemsType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.type")
EnabledType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type")
EnabledDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default")
TitleType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.title.type")
TitleDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.title.default")
ValueType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.value.type")
ValueDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.value.default")
ValuesMaxItems.i = CkJsonObject::ckIntOf(jResp,"definitions.properties.conditions_all.items.properties.values.maxItems")
Conditions_allMaxItems.i = CkJsonObject::ckIntOf(jResp,"definitions.properties.conditions_all.maxItems")
Conditions_anyType.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.type")
ItemsType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.type")
GroupType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.group.type")
GroupDefault.s = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.group.default")
NullableType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.nullable.type")
NullableDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.nullable.default")
OperatorsType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.type")
ItemsType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.type")
TerminalType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type")
TerminalDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default")
TitleType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.title.type")
TitleDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.title.default")
ValueType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.value.type")
ValueDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.operators.items.properties.value.default")
OperatorsMaxItems.i = CkJsonObject::ckIntOf(jResp,"definitions.properties.conditions_any.items.properties.operators.maxItems")
RepeatableType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.repeatable.type")
RepeatableDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.repeatable.default")
SubjectType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.subject.type")
SubjectDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.subject.default")
TitleType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.title.type")
TitleDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.title.default")
TypeType = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.type.type")
TypeDefault = CkJsonObject::ckStringOf(jResp,"definitions.properties.conditions_any.items.properties.type.default")
Conditions_anyMaxItems.i = CkJsonObject::ckIntOf(jResp,"definitions.properties.conditions_any.maxItems")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
