PowerBuilder / Support API / Show Changes to Ticket
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer j
integer li_Count_j
string ls_StrVal
string ls_Assignee_id
string ls_Body
string ls_V_Public
string ls_Id
string ls_Value
string ls_Group_id
string ls_TicketId
string ls_V_Url
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://example.zendesk.com/api/v2/macros/:macro_id/apply",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// 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
ls_Assignee_id = loo_JResp.StringOf("result.ticket.assignee_id")
ls_Body = loo_JResp.StringOf("result.ticket.comment.body")
ls_V_Public = loo_JResp.StringOf("result.ticket.comment.public")
ls_Id = loo_JResp.StringOf("result.ticket.fields.id")
ls_Value = loo_JResp.StringOf("result.ticket.fields.value")
ls_Group_id = loo_JResp.StringOf("result.ticket.group_id")
ls_TicketId = loo_JResp.StringOf("result.ticket.id")
ls_V_Url = loo_JResp.StringOf("result.ticket.url")
i = 0
li_Count_i = loo_JResp.SizeOfArray("result.ticket.comment.scoped_body")
do while i < li_Count_i
loo_JResp.I = i
j = 0
li_Count_j = loo_JResp.SizeOfArray("result.ticket.comment.scoped_body[i]")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("result.ticket.comment.scoped_body[i][j]")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
