List Sheets

UiPath.Smartsheet.Activities.Sheets.ListSheets

Uses the Smartsheet List Sheets API to get list of sheets.

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 List Sheets 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

• Modified Since -

  The modified since date. Enter a DateTime or DateTime variable. When specified with a date and time value, the response only includes the objects that are modified on or after the date and time specified.

• Get Org Sheets -

  If true, returns a summarized list of all sheets owned by the members of the organization account. Enter a Boolean or Boolean variable. Gets a summarized list of all sheets owned by the members of the organization account. Requires ADMIN_USERS to set to true.

• Includes -

  The include options: OWNER_INFO, SHEET_VERSION, SOURCE.

• Include All -

  When true will include all records. Enter a Boolean or Boolean 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.

• Sheets -

  The sheets returned. 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.