VBScript / Support API / Show Macro Replica
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("macro_id","<integer>")
success = queryParams.UpdateString("ticket_id","<integer>")
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros/new",queryParams)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(resp.Header)
outFile.WriteLine("Failed.")
WScript.Quit
End If
' 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
Title = jResp.StringOf("macro.title")
Active = jResp.StringOf("macro.active")
Created_at = jResp.StringOf("macro.created_at")
Default = jResp.StringOf("macro.default")
Description = jResp.StringOf("macro.description")
Id = jResp.StringOf("macro.id")
Position = jResp.StringOf("macro.position")
Utc = jResp.StringOf("macro.restriction.utc")
Sint_c = jResp.StringOf("macro.restriction.sint_c")
Updated_at = jResp.StringOf("macro.updated_at")
v_Url = jResp.StringOf("macro.url")
App_installation = jResp.StringOf("macro.app_installation")
Categories = jResp.StringOf("macro.categories")
Permissions = jResp.StringOf("macro.permissions")
Usage_1h = jResp.StringOf("macro.usage_1h")
Usage_7d = jResp.StringOf("macro.usage_7d")
Usage_24h = jResp.StringOf("macro.usage_24h")
Usage_30d = jResp.StringOf("macro.usage_30d")
i = 0
count_i = jResp.SizeOfArray("macro.actions")
Do While i < count_i
jResp.I = i
field = jResp.StringOf("macro.actions[i].field")
value = jResp.StringOf("macro.actions[i].value")
i = i + 1
Loop
outFile.Close
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}"
}
]
}
