Chilkat Online Tools

unicodeCpp / Support API / Filter Definitions

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/relationships/definitions/:target_type",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        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.

    const wchar_t *v_Type = jResp.stringOf(L"definitions.type");
    const wchar_t *Conditions_allType = jResp.stringOf(L"definitions.properties.conditions_all.type");
    const wchar_t *ItemsType = jResp.stringOf(L"definitions.properties.conditions_all.items.type");
    const wchar_t *GroupType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.group.type");
    const wchar_t *Default = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.group.default");
    const wchar_t *NullableType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.nullable.type");
    const wchar_t *NullableDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.nullable.default");
    const wchar_t *OperatorsType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.type");
    ItemsType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.type");
    const wchar_t *TerminalType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type");
    const wchar_t *TerminalDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default");
    const wchar_t *TitleType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.title.type");
    const wchar_t *TitleDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.title.default");
    const wchar_t *ValueType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.value.type");
    const wchar_t *ValueDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.operators.items.properties.value.default");
    int MaxItems = jResp.IntOf(L"definitions.properties.conditions_all.items.properties.operators.maxItems");
    const wchar_t *RepeatableType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.repeatable.type");
    const wchar_t *RepeatableDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.repeatable.default");
    const wchar_t *SubjectType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.subject.type");
    const wchar_t *SubjectDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.subject.default");
    TitleType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.title.type");
    TitleDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.title.default");
    const wchar_t *TypeType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.type.type");
    const wchar_t *TypeDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.type.default");
    const wchar_t *ValuesType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.type");
    ItemsType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.type");
    const wchar_t *EnabledType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type");
    const wchar_t *EnabledDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default");
    TitleType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.title.type");
    TitleDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.title.default");
    ValueType = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.value.type");
    ValueDefault = jResp.stringOf(L"definitions.properties.conditions_all.items.properties.values.items.properties.value.default");
    int ValuesMaxItems = jResp.IntOf(L"definitions.properties.conditions_all.items.properties.values.maxItems");
    int Conditions_allMaxItems = jResp.IntOf(L"definitions.properties.conditions_all.maxItems");
    const wchar_t *Conditions_anyType = jResp.stringOf(L"definitions.properties.conditions_any.type");
    ItemsType = jResp.stringOf(L"definitions.properties.conditions_any.items.type");
    GroupType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.group.type");
    const wchar_t *GroupDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.group.default");
    NullableType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.nullable.type");
    NullableDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.nullable.default");
    OperatorsType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.type");
    ItemsType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.type");
    TerminalType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type");
    TerminalDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default");
    TitleType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.title.type");
    TitleDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.title.default");
    ValueType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.value.type");
    ValueDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.operators.items.properties.value.default");
    int OperatorsMaxItems = jResp.IntOf(L"definitions.properties.conditions_any.items.properties.operators.maxItems");
    RepeatableType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.repeatable.type");
    RepeatableDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.repeatable.default");
    SubjectType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.subject.type");
    SubjectDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.subject.default");
    TitleType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.title.type");
    TitleDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.title.default");
    TypeType = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.type.type");
    TypeDefault = jResp.stringOf(L"definitions.properties.conditions_any.items.properties.type.default");
    int Conditions_anyMaxItems = jResp.IntOf(L"definitions.properties.conditions_any.maxItems");
    }

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}"
    }
  ]
}