EndPoint Read Organizations (Incremental) changed after a specified date

Name

get_organizations_incr

Description

Get a list of organizations changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API reference]

Parameters

Parameter

Label

Required

Options

Description

start_time

Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

YES

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)

exclude_deleted

Exclude Deleted

Option	Value
true	true
false	false

Whether or not you'd like to exclude deleted tickets from the response

per_page

Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(500)`	500	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
created_at	`DT_DBTIMESTAMP`	`datetime`		`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
domain_names	`DT_WSTR`	`nvarchar(144)`	144	`False`
domain_names_1	`DT_WSTR`	`nvarchar(255)`	255	`False`
domain_names_2	`DT_WSTR`	`nvarchar(255)`	255	`False`
domain_names_3	`DT_WSTR`	`nvarchar(255)`	255	`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
group_id	`DT_I8`	`bigint`		`False`
shared_comments	`DT_BOOL`	`bit`		`False`
shared_tickets	`DT_BOOL`	`bit`		`False`
tags	`DT_WSTR`	`nvarchar(144)`	144	`False`
tags_1	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_2	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_3	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_4	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_5	`DT_WSTR`	`nvarchar(500)`	500	`False`
updated_at	`DT_DBTIMESTAMP`	`datetime`		`False`
url	`DT_WSTR`	`nvarchar(500)`	500	`False`
organization_field_dt_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
organization_field_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(500)`	500	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
group_id	`DT_I8`	`bigint`		`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
tags	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
organization_fields	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
domain_names	`DT_WSTR`	`nvarchar(1000)`	1000	`True`
shared_comments	`DT_BOOL`	`bit`		`False`
shared_tickets	`DT_BOOL`	`bit`		`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 Organizations (Incremental) changed after a specified date using API Source

Zendesk

Read Organizations (Incremental) changed after a specified date

SSIS API Source - Read from table or endpoint

Read Organizations (Incremental) changed after a specified date using API Destination

Zendesk

Read Organizations (Incremental) changed after a specified date

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get all organizations (incremental) modified after ceratin date/time

Read organizations modified after ceratin date/time. This is incremental data fetch. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_organizations_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

SQL Server

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

Get all organizations (incremental) modified after ceratin date/time

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_organizations_incr
WITH(
	    start_time=''2012-01-31T00:00:00'' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time=''yesterday'' --modified after yesterday
	  --start_time=''now-5h'' --modified after current time minus 5 hours
	  --start_time=''today-60s'' --modified after today minus 60 seconds
	  --start_time=''weekstart'' --modified after weekstart
	  --start_time=''monthstart-1d'' --modified after month start minus 1 day
	  --start_time=''yearstart-1d'' --modified after year start minus 1 day
	  --start_time=''yearstart+1d'' --modified after year start plus 1 day
	  --start_time=''yearend+1d'' --modified after year end plus 1 day
)';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ZENDESK_IN_DATA_GATEWAY];