SQL Server / Support API / Getting Comments
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
-- 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'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
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 @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "comment": {
-- "attachments": [
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>",
-- "thumbnails": [
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>"
-- },
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>"
-- }
-- ]
-- },
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>",
-- "thumbnails": [
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>"
-- },
-- {
-- "content_type": "<string>",
-- "content_url": "<string>",
-- "deleted": "<boolean>",
-- "file_name": "<string>",
-- "height": "<string>",
-- "id": "<integer>",
-- "inline": "<boolean>",
-- "malware_access_override": "<boolean>",
-- "malware_scan_result": "<string>",
-- "mapped_content_url": "<string>",
-- "size": "<integer>",
-- "url": "<string>",
-- "width": "<string>"
-- }
-- ]
-- }
-- ],
-- "audit_id": "<integer>",
-- "author_id": "<integer>",
-- "body": "<string>",
-- "created_at": "<dateTime>",
-- "html_body": "<string>",
-- "id": "<integer>",
-- "metadata": {
-- "aliquipf9_": 29396975.17451787
-- },
-- "plain_body": "<string>",
-- "public": "<boolean>",
-- "type": "<string>",
-- "uploads": [
-- "<string>",
-- "<string>"
-- ],
-- "via": {
-- "channel": "<string>",
-- "source": {
-- "mollit8": -84219258
-- }
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @content_type nvarchar(4000)
DECLARE @content_url nvarchar(4000)
DECLARE @deleted nvarchar(4000)
DECLARE @file_name nvarchar(4000)
DECLARE @height nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @inline nvarchar(4000)
DECLARE @malware_access_override nvarchar(4000)
DECLARE @malware_scan_result nvarchar(4000)
DECLARE @mapped_content_url nvarchar(4000)
DECLARE @size nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @width nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @Audit_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Audit_id OUT, 'comment.audit_id'
DECLARE @Author_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Author_id OUT, 'comment.author_id'
DECLARE @Body nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Body OUT, 'comment.body'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'comment.created_at'
DECLARE @Html_body nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Html_body OUT, 'comment.html_body'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'comment.id'
DECLARE @Aliquipf9_ nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Aliquipf9_ OUT, 'comment.metadata.aliquipf9_'
DECLARE @Plain_body nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Plain_body OUT, 'comment.plain_body'
DECLARE @v_Public nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Public OUT, 'comment.public'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'comment.type'
DECLARE @Channel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Channel OUT, 'comment.via.channel'
DECLARE @Mollit8 int
EXEC sp_OAMethod @jResp, 'IntOf', @Mollit8 OUT, 'comment.via.source.mollit8'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'comment.attachments'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @content_type OUT, 'comment.attachments[i].content_type'
EXEC sp_OAMethod @jResp, 'StringOf', @content_url OUT, 'comment.attachments[i].content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @deleted OUT, 'comment.attachments[i].deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'comment.attachments[i].file_name'
EXEC sp_OAMethod @jResp, 'StringOf', @height OUT, 'comment.attachments[i].height'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'comment.attachments[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @inline OUT, 'comment.attachments[i].inline'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_access_override OUT, 'comment.attachments[i].malware_access_override'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_scan_result OUT, 'comment.attachments[i].malware_scan_result'
EXEC sp_OAMethod @jResp, 'StringOf', @mapped_content_url OUT, 'comment.attachments[i].mapped_content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @size OUT, 'comment.attachments[i].size'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'comment.attachments[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @width OUT, 'comment.attachments[i].width'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'comment.attachments[i].thumbnails'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @content_type OUT, 'comment.attachments[i].thumbnails[j].content_type'
EXEC sp_OAMethod @jResp, 'StringOf', @content_url OUT, 'comment.attachments[i].thumbnails[j].content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @deleted OUT, 'comment.attachments[i].thumbnails[j].deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'comment.attachments[i].thumbnails[j].file_name'
EXEC sp_OAMethod @jResp, 'StringOf', @height OUT, 'comment.attachments[i].thumbnails[j].height'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'comment.attachments[i].thumbnails[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @inline OUT, 'comment.attachments[i].thumbnails[j].inline'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_access_override OUT, 'comment.attachments[i].thumbnails[j].malware_access_override'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_scan_result OUT, 'comment.attachments[i].thumbnails[j].malware_scan_result'
EXEC sp_OAMethod @jResp, 'StringOf', @mapped_content_url OUT, 'comment.attachments[i].thumbnails[j].mapped_content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @size OUT, 'comment.attachments[i].thumbnails[j].size'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'comment.attachments[i].thumbnails[j].url'
EXEC sp_OAMethod @jResp, 'StringOf', @width OUT, 'comment.attachments[i].thumbnails[j].width'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'comment.uploads'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'comment.uploads[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id
Postman Collection Item JSON
{
"name": "Getting Comments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id",
"value": "<integer>"
},
{
"key": "ticket_comment_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* End Users\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/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id"
},
{
"key": "ticket_comment_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"comment\": {\n \"attachments\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n }\n ],\n \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aliquipf9_\": 29396975.17451787\n },\n \"plain_body\": \"<string>\",\n \"public\": \"<boolean>\",\n \"type\": \"<string>\",\n \"uploads\": [\n \"<string>\",\n \"<string>\"\n ],\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"mollit8\": -84219258\n }\n }\n }\n}"
}
]
}
