Reference

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 Required Options
Name: SheetId

Label: SheetId

 YES
Name: Id

Label: Row Id(s) - Comma separated

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

Label: Ignore If Rows Not Found

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.
Option Value
true true
false false

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
BatchMessage DT_WSTR nvarchar(4000) 4000
BatchResultCode DT_I4 int
HttpStatusCode DT_I4 int
If the column you are looking for is missing, consider customizing Smartsheet Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
Required columns that you need to supply are bolded.

Examples

SSIS

Use Smartsheet Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Smartsheet
Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
Smartsheet
Delete Sheet Rows
Required Parameters
SheetId Fill-in the parameter...
Row Id(s) - Comma separated Fill-in the parameter...
Optional Parameters
Ignore If Rows Not Found
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to delete sheet rows:

API Destination - Smartsheet
Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
Smartsheet
[Dynamic Table]
Delete
Required Parameters
SheetId Fill-in the parameter...
Row Id(s) - Comma separated Fill-in the parameter...
Optional Parameters
Ignore If Rows Not Found
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Delete sheet rows 

SELECT * FROM [dynamic_table_name]
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 [dynamic_table_name]
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).