Skip to main content

Get Report

UiPath.Smartsheet.Activities.Reports.GetReport

Uses the Smartsheet Get Report API to get a report from Smartsheet.

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 Report 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​

  • ReportId - The Id of the report. Enter a Int64 or Int64 variable.
  • Local Folder - The local folder to download a report to. Enter a String or String variable. If not populated the activity will return a report object
  • Include - List of elements to include in the report. Choose one of the following options: attachments, cellLinks, data, discussions, filters, forms, ruleRecipients, rules, shares.
  • Page Size - Number of rows per page. A Int32 or Int32 variable. If not specified, the default value is 100.
  • Page - Which page number (1-based) to return. A Int32 or Int32 variable. If not specified, the default value is 1.
  • Report - The report object. Enter a Report 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.