Note: This connection property is DEPRECATED and will be removed in the next major release. In the future, UseLegacyAPI=false will be the default state and the only one available.

Determines what API to use for discovering tables metadata (and some columns metadata as well).

Data Type

bool

Default Value

false

Remarks

Disabling this connection property will cause the driver to utilize more recent API-s instead of using the deprecated Home API for discovering metadata.

When the new API is used (property is disabled), reading some of the Info_ tables (Info_Sheets, Info_Templates, Info_Folders, etc.) is less performant in comparison to when the Home API is used. That's because the driver has to make an API call for every folder/subfolder in the workspaces of your Smartsheet account to read the corresponding resource/object for the table, due to the way that the new API is organized. That's significantly more API calls compared to when the driver utilizes the Home API for reading the data.

Additionally, the following changes apply to the data model when this property is disabled:

• Info_Home is not included as a table in the data model.
• A RootFolderId pseudo-column is included in the metadata of Info_Folders, Info_Templates, Info_Sheets and Info_Reports.
• The CreatedAt and ModifiedAt columns are included in the metadata of Info_Folders.
• Data for some columns in some tables can't be retrieved (NULL values are reported for every record). For more information regarding this, refer to the entity-specific documentation sections for the following entities: Info_Sheets, Info_Templates, Info_Folders, Info_Workspaces.
• Retrieving metadata for dynamic sheet tables and dynamic report views is faster.