Chilkat Online Tools

PureBasic / Support API / Retrieve Supported Filter Definition Items

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/olas/policies/definitions",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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