EndPoint Get Sheet Fields

Name

get_sheet_fields

Get Sheet fields by Sheet ID. [API reference]

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.

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`

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.

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

Smartsheet

Get Sheet Fields

Smartsheet

Get Sheet Fields