C / Support API / Filter Definitions
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *v_Type;
const char *Conditions_allType;
const char *ItemsType;
const char *GroupType;
const char *Default;
const char *NullableType;
const char *NullableDefault;
const char *OperatorsType;
const char *TerminalType;
const char *TerminalDefault;
const char *TitleType;
const char *TitleDefault;
const char *ValueType;
const char *ValueDefault;
int MaxItems;
const char *RepeatableType;
const char *RepeatableDefault;
const char *SubjectType;
const char *SubjectDefault;
const char *TypeType;
const char *TypeDefault;
const char *ValuesType;
const char *EnabledType;
const char *EnabledDefault;
int ValuesMaxItems;
int Conditions_allMaxItems;
const char *Conditions_anyType;
const char *GroupDefault;
int OperatorsMaxItems;
int Conditions_anyMaxItems;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/relationships/definitions/:target_type",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_Type = CkJsonObject_stringOf(jResp,"definitions.type");
Conditions_allType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.type");
GroupType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.group.type");
Default = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.group.default");
NullableType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.nullable.type");
NullableDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.nullable.default");
OperatorsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.type");
TerminalType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type");
TerminalDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default");
TitleType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.title.type");
TitleDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.title.default");
ValueType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.value.type");
ValueDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.operators.items.properties.value.default");
MaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_all.items.properties.operators.maxItems");
RepeatableType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.repeatable.type");
RepeatableDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.repeatable.default");
SubjectType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.type");
SubjectDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.default");
TitleType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.title.type");
TitleDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.title.default");
TypeType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.type.type");
TypeDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.type.default");
ValuesType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.values.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.type");
EnabledType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type");
EnabledDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default");
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");
ValuesMaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_all.items.properties.values.maxItems");
Conditions_allMaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_all.maxItems");
Conditions_anyType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.type");
GroupType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.group.type");
GroupDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.group.default");
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");
OperatorsMaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_any.items.properties.operators.maxItems");
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");
Conditions_anyMaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_any.maxItems");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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}"
}
]
}
