C / Support API / Show Changes to Ticket
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
int j;
int count_j;
const char *strVal;
const char *Assignee_id;
const char *Body;
const char *v_Public;
const char *Id;
const char *Value;
const char *Group_id;
const char *TicketId;
const char *v_Url;
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");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/macros/:macro_id/apply",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "result": {
// "ticket": {
// "assignee_id": "<integer>",
// "comment": {
// "body": "<string>",
// "public": "<boolean>",
// "scoped_body": [
// [
// "<string>",
// "<string>"
// ],
// [
// "<string>",
// "<string>"
// ]
// ]
// },
// "fields": {
// "id": "<integer>",
// "value": "<string>"
// },
// "group_id": "<integer>",
// "id": "<integer>",
// "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.
Assignee_id = CkJsonObject_stringOf(jResp,"result.ticket.assignee_id");
Body = CkJsonObject_stringOf(jResp,"result.ticket.comment.body");
v_Public = CkJsonObject_stringOf(jResp,"result.ticket.comment.public");
Id = CkJsonObject_stringOf(jResp,"result.ticket.fields.id");
Value = CkJsonObject_stringOf(jResp,"result.ticket.fields.value");
Group_id = CkJsonObject_stringOf(jResp,"result.ticket.group_id");
TicketId = CkJsonObject_stringOf(jResp,"result.ticket.id");
v_Url = CkJsonObject_stringOf(jResp,"result.ticket.url");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"result.ticket.comment.scoped_body");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"result.ticket.comment.scoped_body[i]");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"result.ticket.comment.scoped_body[i][j]");
j = j + 1;
}
i = i + 1;
}
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/macros/:macro_id/apply
Postman Collection Item JSON
{
"name": "Show Changes to Ticket",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id/apply",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id",
"apply"
],
"variable": [
{
"key": "macro_id",
"value": "<integer>"
}
]
},
"description": "Returns the changes the macro would make to a ticket. It doesn't actually\nchange a ticket. You can use the response data in a subsequent API call\nto the [Tickets](/api-reference/ticketing/tickets/tickets/) endpoint to update the ticket.\n\nThe response includes only the ticket fields that would be changed by the\nmacro. To get the full ticket object after the macro is applied,\nsee [Show Ticket After Changes](#show-ticket-after-changes).\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/:macro_id/apply",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id",
"apply"
],
"variable": [
{
"key": "macro_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"result\": {\n \"ticket\": {\n \"assignee_id\": \"<integer>\",\n \"comment\": {\n \"body\": \"<string>\",\n \"public\": \"<boolean>\",\n \"scoped_body\": [\n [\n \"<string>\",\n \"<string>\"\n ],\n [\n \"<string>\",\n \"<string>\"\n ]\n ]\n },\n \"fields\": {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n },\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"url\": \"<string>\"\n }\n }\n}"
}
]
}