Chilkat Online Tools

C# / Support API / Retrieve Supported Filter Definition Items

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "definitions": {
//     "type": "object",
//     "properties": {
//       "all": {
//         "type": "array",
//         "items": {
//           "type": "object",
//           "properties": {
//             "group": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "operators": {
//               "type": "array",
//               "items": {
//                 "type": "object",
//                 "properties": {
//                   "title": {
//                     "type": "string",
//                     "default": "<string>"
//                   },
//                   "value": {
//                     "type": "string",
//                     "default": "<string>"
//                   }
//                 }
//               },
//               "maxItems": 2
//             },
//             "target": {
//               "type": "string",
//               "nullable": true,
//               "default": "<string>"
//             },
//             "title": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "value": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "values": {
//               "type": "object",
//               "properties": {
//                 "list": {
//                   "type": "array",
//                   "items": {
//                     "type": "object",
//                     "properties": {
//                       "title": {
//                         "type": "string",
//                         "default": "<string>"
//                       },
//                       "value": {
//                         "type": "string",
//                         "nullable": true,
//                         "default": "<string>"
//                       }
//                     }
//                   },
//                   "maxItems": 2
//                 },
//                 "type": {
//                   "type": "string",
//                   "default": "<string>"
//                 }
//               }
//             }
//           }
//         },
//         "maxItems": 2
//       },
//       "any": {
//         "type": "array",
//         "items": {
//           "type": "object",
//           "properties": {
//             "group": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "operators": {
//               "type": "array",
//               "items": {
//                 "type": "object",
//                 "properties": {
//                   "title": {
//                     "type": "string",
//                     "default": "<string>"
//                   },
//                   "value": {
//                     "type": "string",
//                     "default": "<string>"
//                   }
//                 }
//               },
//               "maxItems": 2
//             },
//             "target": {
//               "type": "string",
//               "nullable": true,
//               "default": "<string>"
//             },
//             "title": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "value": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "values": {
//               "type": "object",
//               "properties": {
//                 "list": {
//                   "type": "array",
//                   "items": {
//                     "type": "object",
//                     "properties": {
//                       "title": {
//                         "type": "string",
//                         "default": "<string>"
//                       },
//                       "value": {
//                         "type": "string",
//                         "nullable": true,
//                         "default": "<string>"
//                       }
//                     }
//                   },
//                   "maxItems": 2
//                 },
//                 "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

string v_Type = jResp.StringOf("definitions.type");
string AllType = jResp.StringOf("definitions.properties.all.type");
string ItemsType = jResp.StringOf("definitions.properties.all.items.type");
string GroupType = jResp.StringOf("definitions.properties.all.items.properties.group.type");
string Default = jResp.StringOf("definitions.properties.all.items.properties.group.default");
string OperatorsType = jResp.StringOf("definitions.properties.all.items.properties.operators.type");
ItemsType = jResp.StringOf("definitions.properties.all.items.properties.operators.items.type");
string TitleType = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.type");
string TitleDefault = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.title.default");
string ValueType = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.type");
string ValueDefault = jResp.StringOf("definitions.properties.all.items.properties.operators.items.properties.value.default");
int MaxItems = jResp.IntOf("definitions.properties.all.items.properties.operators.maxItems");
string TargetType = jResp.StringOf("definitions.properties.all.items.properties.target.type");
bool Nullable = jResp.BoolOf("definitions.properties.all.items.properties.target.nullable");
string TargetDefault = jResp.StringOf("definitions.properties.all.items.properties.target.default");
TitleType = jResp.StringOf("definitions.properties.all.items.properties.title.type");
TitleDefault = jResp.StringOf("definitions.properties.all.items.properties.title.default");
ValueType = jResp.StringOf("definitions.properties.all.items.properties.value.type");
ValueDefault = jResp.StringOf("definitions.properties.all.items.properties.value.default");
string ValuesType = jResp.StringOf("definitions.properties.all.items.properties.values.type");
string ListType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.type");
ItemsType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.type");
TitleType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.type");
TitleDefault = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.title.default");
ValueType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.type");
bool ValueNullable = jResp.BoolOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable");
ValueDefault = jResp.StringOf("definitions.properties.all.items.properties.values.properties.list.items.properties.value.default");
int ListMaxItems = jResp.IntOf("definitions.properties.all.items.properties.values.properties.list.maxItems");
string TypeType = jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.type");
string TypeDefault = jResp.StringOf("definitions.properties.all.items.properties.values.properties.type.default");
int AllMaxItems = jResp.IntOf("definitions.properties.all.maxItems");
string AnyType = jResp.StringOf("definitions.properties.any.type");
ItemsType = jResp.StringOf("definitions.properties.any.items.type");
GroupType = jResp.StringOf("definitions.properties.any.items.properties.group.type");
string GroupDefault = jResp.StringOf("definitions.properties.any.items.properties.group.default");
OperatorsType = jResp.StringOf("definitions.properties.any.items.properties.operators.type");
ItemsType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.type");
TitleType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.type");
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.title.default");
ValueType = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.type");
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.operators.items.properties.value.default");
int OperatorsMaxItems = jResp.IntOf("definitions.properties.any.items.properties.operators.maxItems");
TargetType = jResp.StringOf("definitions.properties.any.items.properties.target.type");
bool TargetNullable = jResp.BoolOf("definitions.properties.any.items.properties.target.nullable");
TargetDefault = jResp.StringOf("definitions.properties.any.items.properties.target.default");
TitleType = jResp.StringOf("definitions.properties.any.items.properties.title.type");
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.title.default");
ValueType = jResp.StringOf("definitions.properties.any.items.properties.value.type");
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.value.default");
ValuesType = jResp.StringOf("definitions.properties.any.items.properties.values.type");
ListType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.type");
ItemsType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.type");
TitleType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.type");
TitleDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.title.default");
ValueType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.type");
ValueNullable = jResp.BoolOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable");
ValueDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.list.items.properties.value.default");
ListMaxItems = jResp.IntOf("definitions.properties.any.items.properties.values.properties.list.maxItems");
TypeType = jResp.StringOf("definitions.properties.any.items.properties.values.properties.type.type");
TypeDefault = jResp.StringOf("definitions.properties.any.items.properties.values.properties.type.default");
int AnyMaxItems = jResp.IntOf("definitions.properties.any.maxItems");

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies/definitions

Postman Collection Item JSON

{
  "name": "Retrieve Supported Filter Definition Items",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies",
        "definitions"
      ]
    },
    "description": "#### Allowed For\n\n* Admins\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/olas/policies/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"group\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"operators\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\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            \"target\": {\n              \"type\": \"string\",\n              \"nullable\": true,\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"value\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"values\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"list\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                      \"title\": {\n                        \"type\": \"string\",\n                        \"default\": \"<string>\"\n                      },\n                      \"value\": {\n                        \"type\": \"string\",\n                        \"nullable\": true,\n                        \"default\": \"<string>\"\n                      }\n                    }\n                  },\n                  \"maxItems\": 2\n                },\n                \"type\": {\n                  \"type\": \"string\",\n                  \"default\": \"<string>\"\n                }\n              }\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"group\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"operators\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\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            \"target\": {\n              \"type\": \"string\",\n              \"nullable\": true,\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"value\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"values\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"list\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                      \"title\": {\n                        \"type\": \"string\",\n                        \"default\": \"<string>\"\n                      },\n                      \"value\": {\n                        \"type\": \"string\",\n                        \"nullable\": true,\n                        \"default\": \"<string>\"\n                      }\n                    }\n                  },\n                  \"maxItems\": 2\n                },\n                \"type\": {\n                  \"type\": \"string\",\n                  \"default\": \"<string>\"\n                }\n              }\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}