Smartsheet Application Scope

UiPath.Smartsheet.Activities.SmartsheetScopeActivity

Uses an (Client ID) and (Client Secret) to establish an OAuth Flow connection between UiPath and your Smartsheet application. This connection authorizes a Robot to call the Smartsheet APIs and access resources on your behalf. You can also choose to authenticate via OAuth Passthrough, an API Token, or reusing an existing Connection.

After establishing a connection, a parent Smartsheet Scope activity can output a record of the connection in a Connection object (Connection) that you can use in subsequent child scope activities.

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. Choose the (Authentication Type) you want to use.
4. Enter values for the input properties as needed.
5. Create and enter a Connection variable for Output property. You can use this variable in subsequent uses of the Smartsheet Scope activity.

In the Body of the Activity

• Authentication Type - The type of authentication to use. The following options are available: Existing Connection, OAuth, API Token, OAuth Passthrough.
• Client ID - The Client ID to use for authentication. Enter a String or String variable.
• Client Secret - The client secret for authentication. Enter a SecureString or SecureString variable.
• Api Access Token - The API Access token to use. Enter a String or String variable.
• Existing Connection - Use an existing connection. Enter a Connection or Connection variable. The Connection variable must be from a previously run scope activity (parent) that still has an active connection.

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.

Options

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Output

• Connection - The connection which can be passed to a child application scope. Enter a Connection variable.