Search Activity

UiPath.Smartsheet.Activities.SearchActivity

Uses the Smartsheet Search Everything API to search for a query in a specific sheet or everything.

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Smartsheet Application Scope activity to your project.
3. Add the Search activity inside the Smartsheet Application Scope activity.
4. Create an enter values for the Input properties.
5. Create and enter values for either the Search Sheet or Search Everything properties.
6. Enter values for the Output properties.
7. Create and enter an ResponseStatus variable for the Output property.

In the Body of the Activity

• Query - The text to use in your query. Enter a String or String variable.
• SheetId - The Id of the sheet you want to search in. Enter a Int64 or Int64 variable.
• Includes - The text to use in your query. Select an option from the following: None, Attachments, Discussions, Summary Fields, Rows.
• Location - Whether to limit the search to your personal workspace. The only available options is Personal Workspace.
• ModifiedSince - Limits response to include only the objects that are modified on or after the date and time specified. Enter a DateTime or DateTime variable.
• Scopes - The scopes you want to use. Select one of the following options: attachments, cellData, comments, folderNames, reportNames, sheetNames, sightNames, summaryFields, templateNames, workspaceNames.
• Search Results - The search result. This field supports only SearchResultItem[] variables.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables.