VBScript / Support API / Search Macros
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = CreateObject("Chilkat_9_5_0.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
set queryParams = CreateObject("Chilkat_9_5_0.JsonObject")
success = queryParams.UpdateString("include","<string>")
success = queryParams.UpdateString("access","<string>")
success = queryParams.UpdateString("active","<boolean>")
success = queryParams.UpdateString("category","<integer>")
success = queryParams.UpdateString("group_id","<integer>")
success = queryParams.UpdateString("only_viewable","<boolean>")
success = queryParams.UpdateString("sort_by","<string>")
success = queryParams.UpdateString("sort_order","<string>")
success = queryParams.UpdateString("query","<string>")
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros/search",queryParams)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
set sbResponseBody = CreateObject("Chilkat_9_5_0.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
set jResp = CreateObject("Chilkat_9_5_0.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)
' {
' "macros": [
' {
' "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": {
' "proidentf9": true
' },
' "updated_at": "<dateTime>",
' "url": "<string>",
' "app_installation": "<string>",
' "categories": "<string>",
' "permissions": "<string>",
' "usage_1h": "<integer>",
' "usage_7d": "<integer>",
' "usage_24h": "<integer>",
' "usage_30d": "<integer>"
' },
' {
' "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": {
' "deserunt_": false,
' "exercitation2": -75718943,
' "eiusmodeaf": 24563232.4790345,
' "estf5": "aute",
' "minim24": -78305859
' },
' "updated_at": "<dateTime>",
' "url": "<string>",
' "app_installation": "<string>",
' "categories": "<string>",
' "permissions": "<string>",
' "usage_1h": "<integer>",
' "usage_7d": "<integer>",
' "usage_24h": "<integer>",
' "usage_30d": "<integer>"
' }
' ],
' "count": "<integer>",
' "next_page": "<string>",
' "previous_page": "<string>"
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
count = jResp.StringOf("count")
next_page = jResp.StringOf("next_page")
previous_page = jResp.StringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("macros")
Do While i < count_i
jResp.I = i
title = jResp.StringOf("macros[i].title")
active = jResp.StringOf("macros[i].active")
created_at = jResp.StringOf("macros[i].created_at")
default = jResp.StringOf("macros[i].default")
description = jResp.StringOf("macros[i].description")
id = jResp.StringOf("macros[i].id")
position = jResp.StringOf("macros[i].position")
Proidentf9 = jResp.BoolOf("macros[i].restriction.proidentf9")
updated_at = jResp.StringOf("macros[i].updated_at")
url = jResp.StringOf("macros[i].url")
app_installation = jResp.StringOf("macros[i].app_installation")
categories = jResp.StringOf("macros[i].categories")
permissions = jResp.StringOf("macros[i].permissions")
usage_1h = jResp.StringOf("macros[i].usage_1h")
usage_7d = jResp.StringOf("macros[i].usage_7d")
usage_24h = jResp.StringOf("macros[i].usage_24h")
usage_30d = jResp.StringOf("macros[i].usage_30d")
Deserunt_ = jResp.BoolOf("macros[i].restriction.deserunt_")
Exercitation2 = jResp.IntOf("macros[i].restriction.exercitation2")
Eiusmodeaf = jResp.StringOf("macros[i].restriction.eiusmodeaf")
Estf5 = jResp.StringOf("macros[i].restriction.estf5")
Minim24 = jResp.IntOf("macros[i].restriction.minim24")
j = 0
count_j = jResp.SizeOfArray("macros[i].actions")
Do While j < count_j
jResp.J = j
field = jResp.StringOf("macros[i].actions[j].field")
value = jResp.StringOf("macros[i].actions[j].value")
j = j + 1
Loop
i = i + 1
Loop
outFile.Close
Curl Command
curl -u login:password -G -d "include=%3Cstring%3E"
-d "access=%3Cstring%3E"
-d "active=%3Cboolean%3E"
-d "category=%3Cinteger%3E"
-d "group_id=%3Cinteger%3E"
-d "only_viewable=%3Cboolean%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-d "query=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/search
Postman Collection Item JSON
{
"name": "Search Macros",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/search?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>&query=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"search"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
},
{
"key": "access",
"value": "<string>",
"description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active macros if true or inactive macros if false"
},
{
"key": "category",
"value": "<integer>",
"description": "Filter macros by category"
},
{
"key": "group_id",
"value": "<integer>",
"description": "Filter macros by group"
},
{
"key": "only_viewable",
"value": "<boolean>",
"description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find macros with matching titles"
}
]
},
"description": "#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\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/search?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>&query=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"search"
],
"query": [
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
},
{
"key": "access",
"value": "<string>",
"description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active macros if true or inactive macros if false"
},
{
"key": "category",
"value": "<integer>",
"description": "Filter macros by category"
},
{
"key": "group_id",
"value": "<integer>",
"description": "Filter macros by group"
},
{
"key": "only_viewable",
"value": "<boolean>",
"description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find macros with matching titles"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macros\": [\n {\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 \"proidentf9\": true\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 {\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 \"deserunt_\": false,\n \"exercitation2\": -75718943,\n \"eiusmodeaf\": 24563232.4790345,\n \"estf5\": \"aute\",\n \"minim24\": -78305859\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 ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
