Endpoint

Get Sheet Fields

Name

get_sheet_fields

Description

Get Sheet fields by Sheet ID. [API reference]

Parameters

Parameter	Label	Required	Options	Description
SheetId	SheetId	YES
ColumnIds	Column Ids (Default=All Columns)	NO		A comma-separated list of column ids. The response contains only the specified columns in the columns array, and individual rows' cells array only contains cells in the specified columns.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I8`	`bigint`		`False`
Version	`DT_I4`	`int`		`False`
Index	`DT_I4`	`int`		`False`
Title	`DT_WSTR`	`nvarchar(100)`	100	`False`
Type	`DT_WSTR`	`nvarchar(50)`	50	`False`
Width	`DT_I4`	`int`		`False`
SystemColumnType	`DT_WSTR`	`nvarchar(100)`	100	`False`
ContactOptionsName	`DT_WSTR`	`nvarchar(500)`	500	`False`
ContactOptionsEmail	`DT_WSTR`	`nvarchar(500)`	500	`False`
Options	`DT_WSTR`	`nvarchar(500)`	500	`False`
Description	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
Validation	`DT_BOOL`	`bit`		`False`
AutoNumberFormatPrefix	`DT_WSTR`	`nvarchar(100)`	100	`False`
AutoNumberFormatFill	`DT_WSTR`	`nvarchar(50)`	50	`False`
AutoNumberFormatSuffix	`DT_WSTR`	`nvarchar(100)`	100	`False`
Format	`DT_WSTR`	`nvarchar(100)`	100	`False`
Symbol	`DT_WSTR`	`nvarchar(50)`	50	`False`
Primary	`DT_BOOL`	`bit`		`False`
Locked	`DT_BOOL`	`bit`		`False`
LockedForUser	`DT_BOOL`	`bit`		`False`

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

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

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

Get Sheet Fields using API Source

Smartsheet

Get Sheet Fields

SSIS API Source - Read from table or endpoint

Get Sheet Fields using API Destination

Smartsheet

Get Sheet Fields

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get sheet fields

SELECT * FROM get_sheet_fields
WITH
(
    "SheetId" = 'abcd-1234-sheetid',
    "Filter" = '$.columns[*]'
)

SQL Server

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

Get sheet fields

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_sheet_fields
WITH
(
    "SheetId" = ''abcd-1234-sheetid'',
    "Filter" = ''$.columns[*]''
)';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];