Swift3 / Support API / Search Macros
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
let queryParams = CkoJsonObject()!
queryParams.update("include", value: "<string>")
queryParams.update("access", value: "<string>")
queryParams.update("active", value: "<boolean>")
queryParams.update("category", value: "<integer>")
queryParams.update("group_id", value: "<integer>")
queryParams.update("only_viewable", value: "<boolean>")
queryParams.update("sort_by", value: "<string>")
queryParams.update("sort_order", value: "<string>")
queryParams.update("query", value: "<string>")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/macros/search", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var title: String?
var active: String?
var created_at: String?
var default: String?
var description: String?
var id: String?
var position: String?
var Proidentf9: Bool
var updated_at: String?
var url: String?
var app_installation: String?
var categories: String?
var permissions: String?
var usage_1h: String?
var usage_7d: String?
var usage_24h: String?
var usage_30d: String?
var Deserunt_: Bool
var Exercitation2: Int
var Eiusmodeaf: String?
var Estf5: String?
var Minim24: Int
var j: Int
var count_j: Int
var field: String?
var value: String?
var count: String? = jResp.string(of: "count")
var next_page: String? = jResp.string(of: "next_page")
var previous_page: String? = jResp.string(of: "previous_page")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "macros").intValue
while i < count_i {
jResp.i = i
title = jResp.string(of: "macros[i].title")
active = jResp.string(of: "macros[i].active")
created_at = jResp.string(of: "macros[i].created_at")
default = jResp.string(of: "macros[i].default")
description = jResp.string(of: "macros[i].description")
id = jResp.string(of: "macros[i].id")
position = jResp.string(of: "macros[i].position")
Proidentf9 = jResp.bool(of: "macros[i].restriction.proidentf9")
updated_at = jResp.string(of: "macros[i].updated_at")
url = jResp.string(of: "macros[i].url")
app_installation = jResp.string(of: "macros[i].app_installation")
categories = jResp.string(of: "macros[i].categories")
permissions = jResp.string(of: "macros[i].permissions")
usage_1h = jResp.string(of: "macros[i].usage_1h")
usage_7d = jResp.string(of: "macros[i].usage_7d")
usage_24h = jResp.string(of: "macros[i].usage_24h")
usage_30d = jResp.string(of: "macros[i].usage_30d")
Deserunt_ = jResp.bool(of: "macros[i].restriction.deserunt_")
Exercitation2 = jResp.int(of: "macros[i].restriction.exercitation2").intValue
Eiusmodeaf = jResp.string(of: "macros[i].restriction.eiusmodeaf")
Estf5 = jResp.string(of: "macros[i].restriction.estf5")
Minim24 = jResp.int(of: "macros[i].restriction.minim24").intValue
j = 0
count_j = jResp.size(ofArray: "macros[i].actions").intValue
while j < count_j {
jResp.j = j
field = jResp.string(of: "macros[i].actions[j].field")
value = jResp.string(of: "macros[i].actions[j].value")
j = j + 1
}
i = i + 1
}
}
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}"
}
]
}
