This page provides a guide to Establishing a Connection to Smartsheet in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Smartsheet

Establishing a Connection shows how to authenticate to Smartsheet and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Smartsheet through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Smartsheet by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Smartsheet

Smartsheet supports connections via the following authentication methods:

• Using the Personal Access Token

Personal Access Token

Use the personal token to test and to access your own data. To obtain the personal token, follow the steps below:

1. Log into Smartsheet.
2. Click Account and select Personal Settings.
3. Click API Access and use the form to generate new access tokens or manage existing access tokens.

Synch Connections

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Smartsheet to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values so that they persist across connections.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models the Smartsheet API as relational tables, views, and stored procedures. Views are tables that cannot be modified.

Static Tables

Some API objects, like Workspaces, Folders, etc., are indexed with 'Info_'. These are defined in schema files, which are simple, text-based configuration files.

Dynamic Tables

You can work with all the Sheets and Reports in your account using the Cloud. In addition to providing information about the static tables, the data model illustrates a sample of what your Sheets and Reports might look like. The actual data model will be obtained dynamically based on your user credentials.

When you connect, the Cloud gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Smartsheet account, such as adding a new table, adding new columns, or changing the data type of a column, will immediately be reflected when you connect using the Cloud.

Stored Procedures

Stored Procedures are function-like interfaces to Smartsheet. They can be used to search, update, and modify information in Smartsheet.

API Restrictions

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

You can add hyperlink columns to table schema files generated by the CreateSchema stored procedure.

After generating a schema file from the desired table, add a new column (attr) as follows:

• Set other:columnid to a unique value (any string that isn't already taken by another column).
• Add an other:hyperlink attribute to the column. Set this attribute to the value in the name attribute of the column you want your new hyperlink column to display hyperlinks for.

  These two values must match exactly.

For example, suppose you have this column in your schema file:

<attr name="MyColumnName" xs:type="string" ... other:columnid="5555555555555555"/>

Your new hyperlink column attached to this column should look like this:

<attr name="nameLink" xs:type="string" ... other:columnid="YourUniqueIDHere" other:hyperlink="MyColumnName"/>

The Cloud models the data in Smartsheet as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Smartsheet Tables

Query Smartsheet Attachments. Attachments can exist on a Comment (i.e., within a Discussion), on a Row, or on a Sheet.

Table Specific Information

Select

When getting data from this table the queries might be slow if you have a lot of sheets. To counter this, specifying SheetId is recommended. Also other parameters like DiscussionId, RowId, CommentId can be specified to get Attachments to the related object.

Retrieve all Attachments from all Sheets.

SELECT * FROM Info_Attachments

Retrieve all Attachments related to a Sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308'

Retrieve all Attachments related to a discussion.

SELECT * FROM Info_Attachments WHERE SHEETId = '2940085806098308' AND DiscussionId = '8206230771525508'

Retrieve all Attachments related to a Row.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve all Attachments related to a Comment.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND CommentId = '1322606759569284'

Retrieve details of a specific Attachment.

SELECT * FROM Info_Attachments WHERE Id = '3053958945105796' AND SheetId = '2940085806098308'

Insert

You can attach a file to a specific row in a specific sheet. Fields required for Insert are SheetId, RowId, Name of the file and either FilePath or ContentEncoded.

INSERT INTO Info_Attachments (SheetId, RowId, Name, FilePath) VALUES ('8179839304787844', '4728727909230468', 'TestSheet.xlsx', 'G:\\\\TestSheet.xlsx')

INSERT INTO Info_Attachments (SheetId, RowId, Name, ContentEncoded) VALUES ('8179839304787844', '4728727909230468', 'TestSheet.xlsx', 'dGVzdGluZyBlbmNvZGVkIHRleHQ=')

Columns

Query Smartsheet Comments in a Discussion.

Table Specific Information

Select

This view returns details for Columns of a specified Discussion. The SheetId parameter is always required.

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308'

Retrieve details of a specified Comment.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND Id = '1322606759569284'

Insert

You can insert a comment to a discussion by providing SheetId, DiscussionId and Text.

INSERT INTO Info_Comments (SheetId, DiscussionId, Text) VALUES ('568679927703428', '4661021235275652', 'This is a comment 3')

Columns

Query Smartsheet Discussions. A Discussion is a collection of one or more Comments. A Discussion can exist on a Row or a Sheet.

Table Specific Information

Select

This view returns a list of Discussions. The SheetId parameter is always required.

Retrieve all Discussions related to a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve Discussions related to a specific Row of a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve details of a specified Comment.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

Insert

You can insert a discussion to a sheet by providing SheetId and FirstDiscussionComment. To add a discussion to a row, provide RowId, SheetId, and FirstDiscussionComment.

INSERT INTO Info_Discussions (SheetId, FirstDiscussionComment) VALUES ('568679927703428', 'This is a comment 1')

INSERT INTO Info_Discussions (RowId, SheetId, FirstDiscussionComment) VALUES ('1889077216995204', '568679927703428', 'This is a comment 2')

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Create, update, delete, and query the Sheet_Content_Calendar table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Customer_Order_Tracking_History table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Event_Plan_Budget table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Expense_Report table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Gantt_Project_with_Hard_Deadline table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Job_Candidate_Tracker table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Sales_Activity_Tracking_by_Rep_Month table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Simple_Sales_Pipeline table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Team_Objectives_Tracker table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Team_Task_List_by_Priority table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_WebFormTest table in Smartsheet.

Columns

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Smartsheet Views

Query the available CellHistory of a Cell in Smartsheet.

Table Specific Information

Select

To get data from this view a SheetId, RowId, and ColumnId are always required.

Retrieve Cell History.

SELECT * FROM Info_CellHistory WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172' AND ColumnId = '7999197812156292'

Columns

Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet.

Table Specific Information

Select

This view returns details for Cells of a specified Row. The SheetId and RowId parameters are always required.

Retrieve Cells.

SELECT * FROM Info_Cells WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Columns

Query Smartsheet Columns in a Sheet or Report.

Table Specific Information

Select

This view returns details for Columns of a specified Sheet. The SheetId parameter is always required.

Retrieve Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308'

Retrieve details of the specified Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308' AND Id = '7999197812156292'

Columns

Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet.

Table Specific Information

Select

This view returns details for Contacts.

Retrieve Contacts.

SELECT * FROM Info_Contacts

Retrieve details of a specified Contact.

SELECT * FROM Info_Contacts WHERE Id = '1322606759569284'

Columns

Query Smartsheet Favorites.

Table Specific Information

Select

This view returns a list of Favorite objects.

Retrieve all Favorite objects.

SELECT * FROM Info_Favorites

Columns

Query Smartsheet Folders in the Sheets Folder for the User, in another Folder, or in a Workspace.

Table Specific Information

Select

Retrieve all Folders.

SELECT * FROM Info_Folders

Retrieve details for a Folder.

SELECT * FROM Info_Folders WHERE Id = '2035256120371076'

Retrieve Folders of a specified Workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Columns

Query Smartsheet Groups.

Table Specific Information

Select

Retrieve all Groups.

SELECT * FROM Info_Groups

Retrieve details for a Group.

SELECT * FROM Info_Groups WHERE Id = '2035256120371076'

Columns

Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.

Table Specific Information

Select

Retrieve all objects located on the Home tab:

SELECT * FROM Info_Home

Columns

Query Smartsheet Reports.

Table Specific Information

Select

Retrieve all Reports.

SELECT * FROM Info_Reports

Retrieve Reports located in a specific Workspace.

SELECT * FROM Info_Reports WHERE WorkspaceId = '6773684447799172'

Retrieve Reports located in a specific Folder.

SELECT * FROM Info_Reports WHERE FolderId = '6773684447799172'

Columns

Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments.

Table Specific Information

Select

This view returns a list of Sheet Rows. The SheetId parameter is always required.

Retrieve all Rows of a Sheet.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308'

Retrieve details of a specified Row.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

Columns

Query Smartsheet Server Information including application constants.

Table Specific Information

Select

Retrieve Server Information:

SELECT * FROM Info_ServerInformation

Columns

Query the Sharing operations of Reports, Sheets, and Workspaces.

Table Specific Information

Select

This view returns a list of Shares. Either the SheetId or WorkspaceId parameter is always required.

Retrieve all Shares related to a Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308'

Retrieve all Shares related to a Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114'

Retrieve details of a Share related to a specified Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308' AND Id = '1928085806875098'

Retrieve details of a Share related to a specified Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114' AND Id = '2928085806875091'

Columns

Query Smartsheets Sheets. A Sheet can exist in the Sheets folder for the user (Home), in a Folder, or in a Workspace. It is comprised of Columns, Rows, and Cells, and may optionally contain Attachments and Discussions.

Table Specific Information

Select

Retrieve all Sheets.

SELECT * FROM Info_Sheets

Retrieve Sheets located in a specific Folder.

SELECT * FROM Info_Sheets WHERE FolderId = '2928085806875091'

Retrieve Sheets located in a specific Workspace.

SELECT * FROM Info_Sheets WHERE WorkspaceId = '1928085806875098'

Columns

Query Smartsheet Templates.

Table Specific Information

Select

By default this view returns all Templates created by the user. If the TemplateType filter is set to 'public' , the public templates will be returned.

Retrieve all Templates.

SELECT * FROM Info_Templates

Retrieve all other public Templates.

SELECT * FROM Info_Templates WHERE TemplateType = 'public'

Retrieve Templates located on a specific folder.

SELECT * FROM Info_Templates WHERE FolderId = '2928085806875091'

Retrieve Templates located on a specific Workspace.

SELECT * FROM Info_Templates WHERE WorkspaceId = '1928085806875098'

Columns

Query the Users in the organization.

Table Specific Information

Select

Retrieve all Users.

SELECT * FROM Info_Users

Retrieve all Users of a specific Group.

SELECT * FROM Info_Users WHERE GroupId = '2928085806875091'

Columns

Query Smartsheet Workspaces.

Table Specific Information

Select

Retrieve all Workspaces.

SELECT * FROM Info_Workspaces

Retrieve all details for a specific Workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

The Smartsheet table Report_Sales_Activity_And_Team_Objectives.

Columns

Query the Report_Tasks_and_Events view in Smartsheet.

Columns

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Smartsheet.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Smartsheet, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Smartsheet Stored Procedures

Copy rows form to another sheet.

Input

Result Set Columns

Copy sheets form to another folder/home/workplace.

Input

Result Set Columns

Create a sheet.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Result Set Columns

Deletes the attachment specified.

Input

Result Set Columns

Delete a specified sheet.

Input

Result Set Columns

Import a CSV or XLSX file to the top-level 'sheets' folder. You can also import it to a specific folder or workspace by specifying their id. You should specify only one of them.

Input

Result Set Columns

Move rows form to another sheet.

Input

Result Set Columns

Moves the specified sheet to a new location..

Input

Result Set Columns

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Smartsheet:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Sheet_Test_Sheet table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Sheet_Test_Sheet' 

Columns

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2

Columns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Sheet_Test_Sheet table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Sheet_Test_Sheet' 
          

Columns

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:smartsheet:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Data Type Mappings

The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

Authentication

Connection

OAuth

SSL

Logging

Schema

Miscellaneous

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet.

Possible Values

Data Type

string

Default Value

"PersonalAccessToken"

Remarks

Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet

The Personal Access Token that can be generated from the Smartsheet UI.

Data Type

string

Default Value

""

Remarks

The Personal Access Token that can be generated from the Smartsheet UI.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

The hosting region for your Smartsheet account.

Possible Values

Data Type

string

Default Value

"Global"

Remarks

The hosting region for your Smartsheet account. Available values are: GLOBAL,EU,GOV.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

The client Id assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Indicates whether or not the provider should detect column names from the first row.

Data Type

bool

Default Value

false

Remarks

If true, the first row will be used as a column header. Otherwise, the pseudo column names A, B, C, etc. will be used.

The Cloud will follow the additional specifications below to detect column headers:

• Headers should not contain special characters.
• All column headers must be nonempty.

Set to True if you want to hide currency symbols and percentage signs in numeric values. This will also convert these columns from varchar to double. Only works if TypeDetectionScheme is set to RowScan and at least the first RowScanDepth values for that column are convertable to double.

Data Type

bool

Default Value

false

Remarks

Set to True if you want to hide currency symbols and percentage signs in numeric values. This will also convert these columns from varchar to double. Only works if TypeDetectionScheme is set to RowScan and at least the first RowScanDepth values for that column are convertable to double.

If set to false and any of the specified Row IDs are not found, no rows will be deleted, and a 'not found' error will be returned.

Data Type

bool

Default Value

false

Remarks

If set to false and any of the specified Row IDs are not found, no rows will be deleted, and a 'not found' error will be returned.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

The maximum number of results to return per page from Smartsheet.

Data Type

int

Default Value

500

Remarks

The Pagesize property affects the maximum number of results to return per page from Smartsheet. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Controls whether new functionality, such as multi-contact data is returned as: Backwards-compatible, text format (level 0, default) Multi-contact data (level 1) Multi-contact data (report-compatible, level 2) Multi-picklist data (level 3) .

Possible Values

Data Type

string

Default Value

"2"

Remarks

The minimum level required to get data for 'report' tables is 2.

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

100

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

Determines how to determine the data types of columns.

Possible Values

Data Type

string

Default Value

"RowScan"

Remarks

Whether or not to include the full file path in the name of an exposed table or view, corresponding to a sheet or report.

Data Type

bool

Default Value

false

Remarks

If set to true, the names of the exposed sheets as tables and reports as views, will include the full file path. Ex. SalesSheets_Agents_MonthlyReports_Sheet_JuneSheet.

If set to false, the tables and views corresponding to the sheets and reports, will be exposed using only the file's name. Ex. Sheet_JuneSheet.

Boolean determining if simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

Smartsheet tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.

Indicates whether the cell will use the Value fields as its value or the DisplayValue field.

Possible Values

Data Type

string

Default Value

"Auto"

Remarks

• If Auto the driver will use which field its not empty.
• If Value the driver will use the Value field.
• If DisplayValue the driver will use the DisplayValue field.