SQL Server / Support API / List Macros
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'access', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'active', '<boolean>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'category', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'group_id', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'only_viewable', '<boolean>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_by', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_order', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://example.zendesk.com/api/v2/macros', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @title nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @default nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @position nvarchar(4000)
DECLARE @Proidentf9 int
DECLARE @updated_at nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @app_installation nvarchar(4000)
DECLARE @categories nvarchar(4000)
DECLARE @permissions nvarchar(4000)
DECLARE @usage_1h nvarchar(4000)
DECLARE @usage_7d nvarchar(4000)
DECLARE @usage_24h nvarchar(4000)
DECLARE @usage_30d nvarchar(4000)
DECLARE @Deserunt_ int
DECLARE @Exercitation2 int
DECLARE @Eiusmodeaf nvarchar(4000)
DECLARE @Estf5 nvarchar(4000)
DECLARE @Minim24 int
DECLARE @j int
DECLARE @count_j int
DECLARE @field nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @count OUT, 'count'
DECLARE @next_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page OUT, 'next_page'
DECLARE @previous_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previous_page OUT, 'previous_page'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'macros'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'macros[i].title'
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'macros[i].active'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'macros[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @default OUT, 'macros[i].default'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'macros[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'macros[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'macros[i].position'
EXEC sp_OAMethod @jResp, 'BoolOf', @Proidentf9 OUT, 'macros[i].restriction.proidentf9'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'macros[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'macros[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @app_installation OUT, 'macros[i].app_installation'
EXEC sp_OAMethod @jResp, 'StringOf', @categories OUT, 'macros[i].categories'
EXEC sp_OAMethod @jResp, 'StringOf', @permissions OUT, 'macros[i].permissions'
EXEC sp_OAMethod @jResp, 'StringOf', @usage_1h OUT, 'macros[i].usage_1h'
EXEC sp_OAMethod @jResp, 'StringOf', @usage_7d OUT, 'macros[i].usage_7d'
EXEC sp_OAMethod @jResp, 'StringOf', @usage_24h OUT, 'macros[i].usage_24h'
EXEC sp_OAMethod @jResp, 'StringOf', @usage_30d OUT, 'macros[i].usage_30d'
EXEC sp_OAMethod @jResp, 'BoolOf', @Deserunt_ OUT, 'macros[i].restriction.deserunt_'
EXEC sp_OAMethod @jResp, 'IntOf', @Exercitation2 OUT, 'macros[i].restriction.exercitation2'
EXEC sp_OAMethod @jResp, 'StringOf', @Eiusmodeaf OUT, 'macros[i].restriction.eiusmodeaf'
EXEC sp_OAMethod @jResp, 'StringOf', @Estf5 OUT, 'macros[i].restriction.estf5'
EXEC sp_OAMethod @jResp, 'IntOf', @Minim24 OUT, 'macros[i].restriction.minim24'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'macros[i].actions'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'macros[i].actions[j].field'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'macros[i].actions[j].value'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
