Chilkat Online Tools

delphiDll / Support API / Retrieve Supported Filter Definition Items

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_Type: PWideChar;
AllType: PWideChar;
ItemsType: PWideChar;
GroupType: PWideChar;
Default: PWideChar;
OperatorsType: PWideChar;
TitleType: PWideChar;
TitleDefault: PWideChar;
ValueType: PWideChar;
ValueDefault: PWideChar;
MaxItems: Integer;
TargetType: PWideChar;
Nullable: Boolean;
TargetDefault: PWideChar;
ValuesType: PWideChar;
ListType: PWideChar;
ValueNullable: Boolean;
ListMaxItems: Integer;
TypeType: PWideChar;
TypeDefault: PWideChar;
AllMaxItems: Integer;
AnyType: PWideChar;
GroupDefault: PWideChar;
OperatorsMaxItems: Integer;
TargetNullable: Boolean;
AnyMaxItems: Integer;

begin
// 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/olas/policies/definitions',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

v_Type := CkJsonObject__stringOf(jResp,'definitions.type');
AllType := CkJsonObject__stringOf(jResp,'definitions.properties.all.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.type');
GroupType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.group.type');
Default := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.group.default');
OperatorsType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.items.type');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.items.properties.value.type');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.operators.items.properties.value.default');
MaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.all.items.properties.operators.maxItems');
TargetType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.target.type');
Nullable := CkJsonObject_BoolOf(jResp,'definitions.properties.all.items.properties.target.nullable');
TargetDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.target.default');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.value.type');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.value.default');
ValuesType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.type');
ListType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.type');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.properties.value.type');
ValueNullable := CkJsonObject_BoolOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.properties.value.nullable');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.list.items.properties.value.default');
ListMaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.all.items.properties.values.properties.list.maxItems');
TypeType := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.type.type');
TypeDefault := CkJsonObject__stringOf(jResp,'definitions.properties.all.items.properties.values.properties.type.default');
AllMaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.all.maxItems');
AnyType := CkJsonObject__stringOf(jResp,'definitions.properties.any.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.type');
GroupType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.group.type');
GroupDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.group.default');
OperatorsType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.items.type');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.items.properties.value.type');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.operators.items.properties.value.default');
OperatorsMaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.any.items.properties.operators.maxItems');
TargetType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.target.type');
TargetNullable := CkJsonObject_BoolOf(jResp,'definitions.properties.any.items.properties.target.nullable');
TargetDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.target.default');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.value.type');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.value.default');
ValuesType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.type');
ListType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.type');
ItemsType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.type');
TitleType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.properties.title.type');
TitleDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.properties.title.default');
ValueType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.properties.value.type');
ValueNullable := CkJsonObject_BoolOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.properties.value.nullable');
ValueDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.list.items.properties.value.default');
ListMaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.any.items.properties.values.properties.list.maxItems');
TypeType := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.type.type');
TypeDefault := CkJsonObject__stringOf(jResp,'definitions.properties.any.items.properties.values.properties.type.default');
AnyMaxItems := CkJsonObject_IntOf(jResp,'definitions.properties.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/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}"
    }
  ]
}