Chilkat Online Tools

Swift3 / Support API / Filter Definitions

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "login"
    http.password = "password"

    http.setRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://example.zendesk.com/api/v2/relationships/definitions/:target_type", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        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

    var v_Type: String? = jResp.string(of: "definitions.type")
    var Conditions_allType: String? = jResp.string(of: "definitions.properties.conditions_all.type")
    var ItemsType: String? = jResp.string(of: "definitions.properties.conditions_all.items.type")
    var GroupType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.group.type")
    var Default: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.group.default")
    var NullableType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.nullable.type")
    var NullableDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.nullable.default")
    var OperatorsType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.type")
    ItemsType = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.type")
    var TerminalType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type")
    var TerminalDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default")
    var TitleType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.title.type")
    var TitleDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.title.default")
    var ValueType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.value.type")
    var ValueDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.operators.items.properties.value.default")
    var MaxItems: Int = jResp.int(of: "definitions.properties.conditions_all.items.properties.operators.maxItems").intValue
    var RepeatableType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.repeatable.type")
    var RepeatableDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.repeatable.default")
    var SubjectType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.subject.type")
    var SubjectDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.subject.default")
    TitleType = jResp.string(of: "definitions.properties.conditions_all.items.properties.title.type")
    TitleDefault = jResp.string(of: "definitions.properties.conditions_all.items.properties.title.default")
    var TypeType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.type.type")
    var TypeDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.type.default")
    var ValuesType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.type")
    ItemsType = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.type")
    var EnabledType: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type")
    var EnabledDefault: String? = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default")
    TitleType = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.title.type")
    TitleDefault = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.title.default")
    ValueType = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.value.type")
    ValueDefault = jResp.string(of: "definitions.properties.conditions_all.items.properties.values.items.properties.value.default")
    var ValuesMaxItems: Int = jResp.int(of: "definitions.properties.conditions_all.items.properties.values.maxItems").intValue
    var Conditions_allMaxItems: Int = jResp.int(of: "definitions.properties.conditions_all.maxItems").intValue
    var Conditions_anyType: String? = jResp.string(of: "definitions.properties.conditions_any.type")
    ItemsType = jResp.string(of: "definitions.properties.conditions_any.items.type")
    GroupType = jResp.string(of: "definitions.properties.conditions_any.items.properties.group.type")
    var GroupDefault: String? = jResp.string(of: "definitions.properties.conditions_any.items.properties.group.default")
    NullableType = jResp.string(of: "definitions.properties.conditions_any.items.properties.nullable.type")
    NullableDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.nullable.default")
    OperatorsType = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.type")
    ItemsType = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.type")
    TerminalType = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type")
    TerminalDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default")
    TitleType = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.title.type")
    TitleDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.title.default")
    ValueType = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.value.type")
    ValueDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.operators.items.properties.value.default")
    var OperatorsMaxItems: Int = jResp.int(of: "definitions.properties.conditions_any.items.properties.operators.maxItems").intValue
    RepeatableType = jResp.string(of: "definitions.properties.conditions_any.items.properties.repeatable.type")
    RepeatableDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.repeatable.default")
    SubjectType = jResp.string(of: "definitions.properties.conditions_any.items.properties.subject.type")
    SubjectDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.subject.default")
    TitleType = jResp.string(of: "definitions.properties.conditions_any.items.properties.title.type")
    TitleDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.title.default")
    TypeType = jResp.string(of: "definitions.properties.conditions_any.items.properties.type.type")
    TypeDefault = jResp.string(of: "definitions.properties.conditions_any.items.properties.type.default")
    var Conditions_anyMaxItems: Int = jResp.int(of: "definitions.properties.conditions_any.maxItems").intValue

}

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