Foxpro / Support API / List Macros
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lnProidentf9
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcApp_installation
LOCAL lcCategories
LOCAL lcPermissions
LOCAL lcUsage_1h
LOCAL lcUsage_7d
LOCAL lcUsage_24h
LOCAL lcUsage_30d
LOCAL lnDeserunt_
LOCAL lnExercitation2
LOCAL lcEiusmodeaf
LOCAL lcEstf5
LOCAL lnMinim24
LOCAL j
LOCAL lnCount_j
LOCAL lcField
LOCAL lcValue
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* 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')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("include","<string>")
loQueryParams.UpdateString("access","<string>")
loQueryParams.UpdateString("active","<boolean>")
loQueryParams.UpdateString("category","<integer>")
loQueryParams.UpdateString("group_id","<integer>")
loQueryParams.UpdateString("only_viewable","<boolean>")
loQueryParams.UpdateString("sort_by","<string>")
loQueryParams.UpdateString("sort_order","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("macros")
DO WHILE i < lnCount_i
loJResp.I = i
lcTitle = loJResp.StringOf("macros[i].title")
lcActive = loJResp.StringOf("macros[i].active")
lcCreated_at = loJResp.StringOf("macros[i].created_at")
lcDefault = loJResp.StringOf("macros[i].default")
lcDescription = loJResp.StringOf("macros[i].description")
lcId = loJResp.StringOf("macros[i].id")
lcPosition = loJResp.StringOf("macros[i].position")
lnProidentf9 = loJResp.BoolOf("macros[i].restriction.proidentf9")
lcUpdated_at = loJResp.StringOf("macros[i].updated_at")
lcUrl = loJResp.StringOf("macros[i].url")
lcApp_installation = loJResp.StringOf("macros[i].app_installation")
lcCategories = loJResp.StringOf("macros[i].categories")
lcPermissions = loJResp.StringOf("macros[i].permissions")
lcUsage_1h = loJResp.StringOf("macros[i].usage_1h")
lcUsage_7d = loJResp.StringOf("macros[i].usage_7d")
lcUsage_24h = loJResp.StringOf("macros[i].usage_24h")
lcUsage_30d = loJResp.StringOf("macros[i].usage_30d")
lnDeserunt_ = loJResp.BoolOf("macros[i].restriction.deserunt_")
lnExercitation2 = loJResp.IntOf("macros[i].restriction.exercitation2")
lcEiusmodeaf = loJResp.StringOf("macros[i].restriction.eiusmodeaf")
lcEstf5 = loJResp.StringOf("macros[i].restriction.estf5")
lnMinim24 = loJResp.IntOf("macros[i].restriction.minim24")
j = 0
lnCount_j = loJResp.SizeOfArray("macros[i].actions")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("macros[i].actions[j].field")
lcValue = loJResp.StringOf("macros[i].actions[j].value")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros
Postman Collection Item JSON
{
"name": "List Macros",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros"
],
"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"
}
]
},
"description": "Lists all shared and personal macros available to the current user.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\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?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros"
],
"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"
}
]
}
},
"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}"
}
]
}
