SearchResourcesSearch Method (String, IEnumerableSearchInclusion, NullableSearchLocation, NullableDateTime, IEnumerableSearchScope)

Searches all sheets that the user can access, for the specified text.

Mirrors to the following Smartsheet REST API method: GET /search

Namespace: Smartsheet.Api
Assemblies: smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0

Syntax

C++

Copy

SearchResult Search(
	string query,
	IEnumerable<SearchInclusion> includes,
	Nullable<SearchLocation> location,
	Nullable<DateTime> modifiedSince,
	IEnumerable<SearchScope> scopes
)

Function Search ( 
	query As String,
	includes As IEnumerable(Of SearchInclusion),
	location As Nullable(Of SearchLocation),
	modifiedSince As Nullable(Of DateTime),
	scopes As IEnumerable(Of SearchScope)
) As SearchResult

SearchResult^ Search(
	String^ query, 
	IEnumerable<SearchInclusion>^ includes, 
	Nullable<SearchLocation> location, 
	Nullable<DateTime> modifiedSince, 
	IEnumerable<SearchScope>^ scopes
)

abstract Search : 
        query : string * 
        includes : IEnumerable<SearchInclusion> * 
        location : Nullable<SearchLocation> * 
        modifiedSince : Nullable<DateTime> * 
        scopes : IEnumerable<SearchScope> -> SearchResult

Parameters

query: Type: SystemString
(required): Text with which to perform the search.
includes: Type: System.Collections.GenericIEnumerableSearchInclusion
includes enum set of inclusions
location: Type: SystemNullableSearchLocation
location when specified with a value of "personalWorkspace limits response to only those items in the user's workspace
modifiedSince: Type: SystemNullableDateTime
only return items modified since this date
scopes: Type: System.Collections.GenericIEnumerableSearchScope
scopes enum set of search filters

Return Value

Type: SearchResult
SearchResult object that contains a maximum of 100 SearchResultems

Exceptions

Exception	Condition
InvalidOperationException	if any argument is null or an empty string
InvalidRequestException	if there is any problem with the REST API request
AuthorizationException	if there is any problem with the REST API authorization (access token)
ResourceNotFoundException	if the resource cannot be found
ServiceUnavailableException	if the REST API service is not available (possibly due to rate limiting)
SmartsheetException	if there is any other error during the operation

Reference

SearchResources Interface

Search Overload

Smartsheet.Api Namespace