Get Sheets

UiPath.MicrosoftOffice365.Activities.Excel.GetSheets

Description

Uses the Microsoft Graph Get worksheet API to retrieve and return an array of worksheets (Sheets) from a specified workbook (Workbook).

Scopes

This activity requires the following scopes:

• Files.Read

OR

• Files.ReadWrite

OR

• Files.Read.All

OR

• Files.ReadWrite.All

OR

• Sites.Read.All

OR

• Sites.ReadWrite.All

Project compatibility

Windows - Legacy | Windows

Configuration

Properties

Common

• DisplayName - The display name of the activity. This property supports String variables and string formatted values.

Input

• Workbook - The DriveItem of the Excel document whose sheets are returned. This object can be retrieved using the Find Files And Folders activity. Use the output property variable from either the Find Files and Folders (First or Results) or Create Workbook (Workbook) activities. When using the Results output property from the Find Files and Folders activity, be sure to specify which item in the array that you want to use (e.g., myWorkbooks(0)).

Misc

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

Output

• Sheets - The sheets from the workbook as an array of strings. This field supports only String[] variables. Required if you plan to use the output data in subsequent activities.

How it works

The following steps and message sequence diagram is 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 steps.
2. Add the Microsoft Office 365 Scope activity to your project.
3. Add an activity or run an external process that outputs a DriveItem object (e.g., Find Files and Folders, Create Workbook, Copy Item).
4. Add the Get Sheets activity inside the Microsoft Office 365 Scope activity.
5. Enter values for the Input properties.
6. Create and enter a String[] variable for your Output property.

7. Run the activity.

   • Your input property values are sent to the GetWorksheet API.
   • The API returns the String[] value to your output property variable.