SQL Server / Support API / Show Macro Replica
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, 'macro_id', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ticket_id', '<integer>'
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/new', @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)
-- {
-- "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
DECLARE @field nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'macro.title'
DECLARE @Active nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'macro.active'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'macro.created_at'
DECLARE @Default nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Default OUT, 'macro.default'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'macro.description'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'macro.id'
DECLARE @Position nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Position OUT, 'macro.position'
DECLARE @Utc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Utc OUT, 'macro.restriction.utc'
DECLARE @Sint_c nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Sint_c OUT, 'macro.restriction.sint_c'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'macro.updated_at'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'macro.url'
DECLARE @App_installation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @App_installation OUT, 'macro.app_installation'
DECLARE @Categories nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Categories OUT, 'macro.categories'
DECLARE @Permissions nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Permissions OUT, 'macro.permissions'
DECLARE @Usage_1h nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Usage_1h OUT, 'macro.usage_1h'
DECLARE @Usage_7d nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Usage_7d OUT, 'macro.usage_7d'
DECLARE @Usage_24h nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Usage_24h OUT, 'macro.usage_24h'
DECLARE @Usage_30d nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Usage_30d OUT, 'macro.usage_30d'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'macro.actions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'macro.actions[i].field'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'macro.actions[i].value'
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 "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}"
}
]
}
