C / Support API / Show Macro Replica
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *field;
const char *value;
const char *Title;
const char *Active;
const char *Created_at;
const char *Default;
const char *Description;
const char *Id;
const char *Position;
const char *Utc;
const char *Sint_c;
const char *Updated_at;
const char *v_Url;
const char *App_installation;
const char *Categories;
const char *Permissions;
const char *Usage_1h;
const char *Usage_7d;
const char *Usage_24h;
const char *Usage_30d;
int i;
int count_i;
// 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");
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"macro_id","<integer>");
CkJsonObject_UpdateString(queryParams,"ticket_id","<integer>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/macros/new",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "macro": {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "utc": -57663786.73485631,
// "sint_c": 56026975.00248328
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// }
// 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.
Title = CkJsonObject_stringOf(jResp,"macro.title");
Active = CkJsonObject_stringOf(jResp,"macro.active");
Created_at = CkJsonObject_stringOf(jResp,"macro.created_at");
Default = CkJsonObject_stringOf(jResp,"macro.default");
Description = CkJsonObject_stringOf(jResp,"macro.description");
Id = CkJsonObject_stringOf(jResp,"macro.id");
Position = CkJsonObject_stringOf(jResp,"macro.position");
Utc = CkJsonObject_stringOf(jResp,"macro.restriction.utc");
Sint_c = CkJsonObject_stringOf(jResp,"macro.restriction.sint_c");
Updated_at = CkJsonObject_stringOf(jResp,"macro.updated_at");
v_Url = CkJsonObject_stringOf(jResp,"macro.url");
App_installation = CkJsonObject_stringOf(jResp,"macro.app_installation");
Categories = CkJsonObject_stringOf(jResp,"macro.categories");
Permissions = CkJsonObject_stringOf(jResp,"macro.permissions");
Usage_1h = CkJsonObject_stringOf(jResp,"macro.usage_1h");
Usage_7d = CkJsonObject_stringOf(jResp,"macro.usage_7d");
Usage_24h = CkJsonObject_stringOf(jResp,"macro.usage_24h");
Usage_30d = CkJsonObject_stringOf(jResp,"macro.usage_30d");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"macro.actions");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
field = CkJsonObject_stringOf(jResp,"macro.actions[i].field");
value = CkJsonObject_stringOf(jResp,"macro.actions[i].value");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "macro_id=%3Cinteger%3E"
-d "ticket_id=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/new
Postman Collection Item JSON
{
"name": "Show Macro Replica",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/new?macro_id=<integer>&ticket_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"new"
],
"query": [
{
"key": "macro_id",
"value": "<integer>",
"description": "(Required) The ID of the macro to replicate"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket from which to build a macro replica"
}
]
},
"description": "Returns an unpersisted macro representation derived from a ticket or macro.\n\nThe endpoint takes one of the following query parameters: `macro_id` or `ticket_id`. If you include both, `macro_id` is used.\n\n#### Allowed For\n* Agents\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/macros/new?macro_id=<integer>&ticket_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"new"
],
"query": [
{
"key": "macro_id",
"value": "<integer>",
"description": "(Required) The ID of the macro to replicate"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket from which to build a macro replica"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macro\": {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"utc\": -57663786.73485631,\n \"sint_c\": 56026975.00248328\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n}"
}
]
}
