Reference

Endpoint Search (cell data or other object types)

Name

search

Description

Get a list of search result object. [API reference]

Parameters

Parameter Required Options
Name: Query

Label: Search Query (use double quotes for exact search)

 YES
Name: SheetId

Label: Sheet ID

Sheet ID to search in. Leave blank to search everywhere.
Name: Scope

Label: Search scope

Scope of the search. Leave blank to search all object types.
Option Value
cellData cellData
attachments attachments
comments comments
folderNames folderNames
reportNames reportNames
sheetNames sheetNames
sightNames sightNames
summaryFields summaryFields
templateNames templateNames
workspaceNames workspaceNames
Name: ModifiedSince

Label: Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
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
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
Name: PageSize

Label: PageSize

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Smartsheet Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Smartsheet
Read and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.
Smartsheet
Search (cell data or other object types)
Required Parameters
Search Query (use double quotes for exact search) Fill-in the parameter...
Optional Parameters
Sheet ID
Search scope cellData
Modified Since
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Smartsheet
Read and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.
Smartsheet
Search (cell data or other object types)
Required Parameters
Search Query (use double quotes for exact search) Fill-in the parameter...
Optional Parameters
Sheet ID
Search scope cellData
Modified Since
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Search 

SELECT * FROM search
WITH
(
    "Query" = 'abcd-1234-query'
)

SQL Server

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

Search 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM search
WITH
(
    "Query" = ''abcd-1234-query''
)';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];