Endpoint

Read Ticket Comments

Name

get_ticket_comments

Description

Returns comments for specified ticket ID. [API reference]

Parameters

Parameter

Label

Required

Options

Description

ticket_id

Ticket ID

YES

sort_order

Sort Order

Option	Value
desc	desc
asc	asc

Sort order

include_inline_images

Include inline images

Option	Value
false	false
true	true

Default is false. When true, inline images are also listed as attachments in the response

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
author_id	`DT_I8`	`bigint`		`False`
body	`DT_NTEXT`	`nvarchar(MAX)`		`False`
plain_body	`DT_NTEXT`	`nvarchar(MAX)`		`False`
html_body	`DT_NTEXT`	`nvarchar(MAX)`		`False`
created_at	`DT_DBTIMESTAMP`	`datetime`		`False`
attachments	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
type	`DT_WSTR`	`nvarchar(100)`	100	`False`
public	`DT_BOOL`	`bit`		`False`
attachments_1_id	`DT_I8`	`bigint`		`False`
attachments_2_id	`DT_I8`	`bigint`		`False`
attachments_3_id	`DT_I8`	`bigint`		`False`
attachments_4_id	`DT_I8`	`bigint`		`False`
attachments_5_id	`DT_I8`	`bigint`		`False`
attachments_1_file_name	`DT_WSTR`	`nvarchar(255)`	255	`False`
attachments_2_file_name	`DT_WSTR`	`nvarchar(255)`	255	`False`
attachments_3_file_name	`DT_WSTR`	`nvarchar(255)`	255	`False`
attachments_4_file_name	`DT_WSTR`	`nvarchar(255)`	255	`False`
attachments_5_file_name	`DT_WSTR`	`nvarchar(255)`	255	`False`
attachments_1_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
attachments_2_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
attachments_3_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
attachments_4_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
attachments_5_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
via_channel	`DT_WSTR`	`nvarchar(100)`	100	`False`
via_source_rel	`DT_WSTR`	`nvarchar(255)`	255	`False`
via_source_from_address	`DT_WSTR`	`nvarchar(500)`	500	`False`
via_source_from_name	`DT_WSTR`	`nvarchar(500)`	500	`False`
via_source_from_original_recipients	`DT_WSTR`	`nvarchar(2000)`	2000	`False`
via_source_to_name	`DT_WSTR`	`nvarchar(500)`	500	`False`
via_source_to_address	`DT_WSTR`	`nvarchar(500)`	500	`False`

If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
author_id	`DT_I8`	`bigint`		`False`
body	`DT_NTEXT`	`nvarchar(MAX)`		`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source component to read data or in API Destination component to read/write data:

Read Ticket Comments using API Source

Zendesk

Read Ticket Comments

SSIS API Source - Read from table or endpoint

Read Ticket Comments using API Destination

Zendesk

Read Ticket Comments

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Read ticket comments

SELECT * FROM get_ticket_comments
WITH
(
    "ticket_id" = 'abcd-1234-ticket_id'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read ticket comments

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_ticket_comments
WITH
(
    "ticket_id" = ''abcd-1234-ticket_id''
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];