C++ / Support API / Show OLA Policy
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/:ola_policy_id",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)
// {
// "ola_policy": {
// "title": "<string>",
// "filter": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "policy_metrics": [
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// },
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// }
// ],
// "position": "<integer>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
// 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 *field = 0;
const char *operator = 0;
const char *value = 0;
const char *business_hours = 0;
const char *metric = 0;
const char *priority = 0;
const char *target = 0;
const char *Title = jResp.stringOf("ola_policy.title");
const char *Created_at = jResp.stringOf("ola_policy.created_at");
const char *Description = jResp.stringOf("ola_policy.description");
const char *Id = jResp.stringOf("ola_policy.id");
const char *Position = jResp.stringOf("ola_policy.position");
const char *Updated_at = jResp.stringOf("ola_policy.updated_at");
const char *v_Url = jResp.stringOf("ola_policy.url");
int i = 0;
int count_i = jResp.SizeOfArray("ola_policy.filter.all");
while (i < count_i) {
jResp.put_I(i);
field = jResp.stringOf("ola_policy.filter.all[i].field");
operator = jResp.stringOf("ola_policy.filter.all[i].operator");
value = jResp.stringOf("ola_policy.filter.all[i].value");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("ola_policy.filter.any");
while (i < count_i) {
jResp.put_I(i);
field = jResp.stringOf("ola_policy.filter.any[i].field");
operator = jResp.stringOf("ola_policy.filter.any[i].operator");
value = jResp.stringOf("ola_policy.filter.any[i].value");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("ola_policy.policy_metrics");
while (i < count_i) {
jResp.put_I(i);
business_hours = jResp.stringOf("ola_policy.policy_metrics[i].business_hours");
metric = jResp.stringOf("ola_policy.policy_metrics[i].metric");
priority = jResp.stringOf("ola_policy.policy_metrics[i].priority");
target = jResp.stringOf("ola_policy.policy_metrics[i].target");
i = i + 1;
}
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/olas/policies/:ola_policy_id
Postman Collection Item JSON
{
"name": "Show OLA Policy",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies/:ola_policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
":ola_policy_id"
],
"variable": [
{
"key": "ola_policy_id",
"value": "<integer>"
}
]
},
"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/:ola_policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies",
":ola_policy_id"
],
"variable": [
{
"key": "ola_policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ola_policy\": {\n \"title\": \"<string>\",\n \"filter\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"policy_metrics\": [\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n },\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n }\n ],\n \"position\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
