Skip to main content

Get Sheet

UiPath.Smartsheet.Activities.Sheets.GetSheet

Uses the Smartsheet Get Sheet API to get a sheet.

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 Get Sheet activity inside the Smartsheet Application Scope activity.
  4. Create and enter values for the Input properties.
  5. Create and enter values for Output properties.
  6. Create and enter an ResponseStatus variable for the Output property.

In the Body of the Activity​

  • Sheet Id - The Id of the sheet to get. Enter a Int64 or Int64 variable.
  • Column Ids - A list of columns to include. Enter a Int64[] or Int64[] variable.
  • Includes - A list of options to include: attachments, crossSheetReferences, discussions, filters, filterDefinitions, format, ganttConfig, objectValue, ownerInfo.
  • Excludes - A list of options to exclude: filteredOutRows, nonexistentCells, linkInFromCellDetails, linksOutToCellsDetails.
  • Row Ids - A list of rows to include. Enter a Int64[] or Int64[] variable.
  • Row Numbers - A list of row numbers to include. Enter a Int32[] or Int32[] variable.
  • Rows Modified Since - Filter to return only rows that have been modified since the date/time. Enter a String or String variable.
  • Page - Which page to return. Enter a Int32 or Int32 variable. If not specified, the default value is 1.
  • Page Size - The maximum number of items to return per page. Enter a Int32 or Int32 variable. If not specified, the default value is 100.
  • Sheet - The sheet object. Enter a Sheet variable.

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). Enter a ResponseStatus variable.