C++ / Support API / Retrieve Supported Filter Definition Items
Back to Collection Items
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/definitions",sbResponseBody);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = http.get_LastStatus();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << http.lastHeader() << "\r\n";
std::cout << "Failed." << "\r\n";
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *v_Type = jResp.stringOf("definitions.type");
const char *AllType = jResp.stringOf("definitions.properties.all.type");
const char *ItemsType = jResp.stringOf("definitions.properties.all.items.type");
const char *GroupType = jResp.stringOf("definitions.properties.all.items.properties.group.type");
const char *Default = jResp.stringOf("definitions.properties.all.items.properties.group.default");
const char *OperatorsType = jResp.stringOf("definitions.properties.all.items.properties.operators.type");
ItemsType = jResp.stringOf("definitions.properties.all.items.properties.operators.items.type");
const char *TitleType = jResp.stringOf("definitions.properties.all.items.properties.operators.items.properties.title.type");
const char *TitleDefault = jResp.stringOf("definitions.properties.all.items.properties.operators.items.properties.title.default");
const char *ValueType = jResp.stringOf("definitions.properties.all.items.properties.operators.items.properties.value.type");
const char *ValueDefault = jResp.stringOf("definitions.properties.all.items.properties.operators.items.properties.value.default");
int MaxItems = jResp.IntOf("definitions.properties.all.items.properties.operators.maxItems");
const char *TargetType = jResp.stringOf("definitions.properties.all.items.properties.target.type");
bool Nullable = jResp.BoolOf("definitions.properties.all.items.properties.target.nullable");
const char *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");
const char *ValuesType = jResp.stringOf("definitions.properties.all.items.properties.values.type");
const char *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");
const char *TypeType = jResp.stringOf("definitions.properties.all.items.properties.values.properties.type.type");
const char *TypeDefault = jResp.stringOf("definitions.properties.all.items.properties.values.properties.type.default");
int AllMaxItems = jResp.IntOf("definitions.properties.all.maxItems");
const char *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");
const char *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}"
}
]
}
