Endpoint

Delete Sheet Rows

Name

delete_sheet_rows

Description

Delete rows from a Sheet by row IDs. [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter

Label

Required

Options

Description

SheetId

YES

Row Id(s) - Comma separated

YES

Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)

IgnoreRowsNotFound

Ignore If Rows Not Found

Option	Value
true	true
false	false

If set to false and any of the specified row Ids are not found, no rows are deleted, and the 'not found' error is returned.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I8`	`bigint`		`False`
BatchMessage	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
BatchResultCode	`DT_I4`	`int`		`False`
HttpStatusCode	`DT_I4`	`int`		`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
Id	`DT_I8`	`bigint`		`False`

Required columns that you need to supply are bolded.

Examples

SSIS

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

Delete rows from [Dynamic Table] table using API Destination

This Endpoint belongs to [Dynamic Table] table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Smartsheet

[Dynamic Table]

Delete

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Delete sheet rows

SELECT * FROM delete_sheet_rows
WHERE Id = 'abcd-1234-id'
WITH
(
    "SheetId" = 'abcd-1234-sheetid'
)

delete_sheet_rows endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

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

Delete sheet rows

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM delete_sheet_rows
WHERE Id = ''abcd-1234-id''
WITH
(
    "SheetId" = ''abcd-1234-sheetid''
)';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];

delete_sheet_rows endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).