CData Sync App は、Smartsheet データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Smartsheet コネクタはCData Sync アプリケーションから使用可能で、Smartsheet からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Smartsheet への接続を作成します。Smartsheet アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSmartsheet コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
Smartsheet は、以下の認証メソッドによる接続をサポートしています。
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。
Smartsheet はOAuth 認証標準を利用しています。これを使用するには、AuthScheme をOAuth に設定する必要があります。OAuth を使って認証するには、アプリケーションを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。
しかし、自分のアカウントにアクセスしたりテスト目的でアクセスする場合は、代わりにPersonalAccessToken 接続プロパティをアプリケーションを作成する際に取得するPersonal Access Token に設定することができます。
詳しくは、OAuth 認証の使用 を参照してください。
このセクションでは、Smartsheet Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Smartsheet にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Smartsheet API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。 ビュー は編集ができないテーブルです。
Workspaces、Folders、etc. のようないくつかのAPI オブジェクトは、'Info_' でインデックス付けされています。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
Sync App を使用すると、アカウント内のすべてのシートとレポートを操作できます。 静的なテーブルの情報提供に加え、データモデルは、シートおよびレポートの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報に基づいて動的に取得されます。
接続時にSync App は、適切なWeb サービスを呼び出してテーブルのリストとテーブルのメタデータを取得します。Sync App を使用して接続すると、新しいテーブルの追加、新しい列の追加、列のデータ型の変更など、Smartsheet アカウントに対して行う変更は即座に反映されます。
ストアドプロシージャ は、Smartsheet のファンクションライクなインターフェースです。これらを使用して、Smartsheet 内の情報を検索、更新、および変更できます。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
Sync App はSmartsheet のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Smartsheet テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Info_Attachments | Query Smartsheet Attachments. Attachments can exist on a Comment (i.e., within a Discussion), on a Row, or on a Sheet. |
Info_Columns | Query Smartsheet Columns in a Sheet or Report. |
Info_Comments | Query Smartsheet Comments in a Discussion. |
Info_Discussions | Query Smartsheet Discussions. A Discussion is a collection of one or more Comments. A Discussion can exist on a Row or a Sheet. |
Query Smartsheet Attachments. Attachments can exist on a Comment (i.e., within a Discussion), on a Row, or on a Sheet.
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'
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=')
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The unique Identifier of the attachment. | |
Name | String | False |
The name of the attachment. | |
Url | String | False |
The temporary URL of the attachment (files only). | |
UrlExpiresInMillis | Long | False |
The temporary URL time to live for the attachment (files only). | |
AttachmentType | String | False |
The attachment type (one of FILE, GOOGLE_DRIVE, LINK, BOX_COM, DROPBOX, EVERNOTE, or EGNYTE). | |
AttachmentSubType | String | False |
The attachment subtype, valId only for either GOOGLE_DRIVE attachments or EGNYTE attachments. Possible values for GOOGLE_DRIVE attachments: DOCUMENT, SPREADSHEET, PRESENTATION, PDF, DRAWING. Possible values for EGNYTE attachments: FOLDER. | |
CreatedAt | Timestamp | False |
A timestamp of when the attachment was originally added | |
UserId | String | False |
The Id of the user who created the attachment. | |
UserEmail | String | False |
The email address of the user. | |
UserName | String | False |
The full name of the user. Read-only. | |
MimeType | String | False |
Attachment MIME type. For example PNG. | |
ParentType | String | False |
The type of object the attachment belongs to. Possible values: SHEET, ROW, or COMMENT. | |
ParentId | String | False |
The Id of the parent. | |
SizeInKb | Long | False |
The size of the file, if the attachmentType is FILE. | |
SheetId | String | False |
The Id of the sheet. | |
RowId | String | False |
The Id of the row. | |
DiscussionId | String | False |
The Id of the discussion. | |
CommentId | String | False |
The Id of the comment. | |
FilePath | String | False |
The path of the file to insert. | |
ContentEncoded | String | False |
BASE64 encoded content of the file to insert. |
Query Smartsheet Comments in a Discussion.
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'
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')
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The unique identifier of the comment. | |
Text | String | False |
The comment body. | |
UserName | String | False |
The user name. | |
UserEmail | String | False |
The email address of the user. | |
CreatedAt | Datetime | False |
The time of creation. | |
ModifiedAt | Datetime | False |
The time of the last modification. | |
AttachmentsAggregate | String | False |
Array of attachment objects. | |
DiscussionId | String | False |
The Id of the discussion. | |
SheetId | String | False |
The Id of the sheet. |
Query Smartsheet Discussions. A Discussion is a collection of one or more Comments. A Discussion can exist on a Row or a Sheet.
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'
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')
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The Id of the discussion. | |
Title | String | False |
The title of the comment. | |
AccessLevel | String | False |
The permissions the user has to access the discussion. | |
ParentId | String | False |
The Id of the directly associated row or sheet. | |
ParentType | String | False |
The type of the directly associated row or sheet. Possible values: SHEET or ROW. | |
LastCommentedAt | Datetime | False |
The time of the most recent comment. | |
LastCommentBy | String | False |
The full name of the user who last commented. | |
CreatorName | String | False |
The full name of the user who created the discussion. | |
ReadOnly | Boolean | False |
Whether the user can modify the discussion. | |
SheetId | String | False |
The sheet Id. | |
RowId | String | False |
The row Id. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
FirstDiscussionComment | String |
This column is used only to INSERT the first comment on a discussion, as it is required. |
Create, update, delete, and query the Sheet_Content_Calendar table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Prio | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Image | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Title & Link | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Details | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Assigned To | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Draft Due | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Draft Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Approved By | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Objective | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Target | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Media Type | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Art Required | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. | |
Placement | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Publication Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Keywords | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Live | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Customer_Order_Tracking_History table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
PO | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
PO Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Ship Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Shipped Via | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Invoice Amount | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Invoice Number | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Inv Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Terms | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Paid | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. | |
Date Paid | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Payment | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Check # | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Event_Plan_Budget table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Task Name | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Assigned | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Progress | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Due Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
$ Each | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Qty | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Budget | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Actual | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Comments | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Expense_Report table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Description | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Expense Category | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Amount | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Manager Approved | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. | |
Comment | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Gantt_Project_with_Hard_Deadline table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
At Risk | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. | |
Task Name | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Start Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
End Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Assigned To | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Duration | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
% Complete | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Predecessors | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Comments | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Job_Candidate_Tracker table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Candidate Name | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Next Steps | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Comments | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
RYG | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Start Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Hiring Mgr | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Referral Source | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Hire Type | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Compensation | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Sales_Activity_Tracking_by_Rep_Month table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Monthly Metric | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Quota | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Actual | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Percent to Goal | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Variance | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Pace | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Simple_Sales_Pipeline table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Company Logo | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Opportunity | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Contact Name | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Sales Stage | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Forecast Amount | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Probability | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Weighted Forecast | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Expected Close Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Sales Rep | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Next Step | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Team_Objectives_Tracker table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Task Name | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Responsible | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
State | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Due Date | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Comments | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_Team_Task_List_by_Priority table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
RYG | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Task | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Assigned To | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Reviewed | Boolean | False |
This column is dynamic and maps to the corresponding field in the API. | |
Status | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Due | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
Notes & Comments | String | False |
This column is dynamic and maps to the corresponding field in the API. |
Create, update, delete, and query the Sheet_WebFormTest table in Smartsheet.
Name | Type | ReadOnly | References | Description |
RowId [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Form Field 1 | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Form Field 2 | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Form Date Field | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
Info_CellHistory | Query the available CellHistory of a Cell in Smartsheet. |
Info_Cells | Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet. |
Info_Contacts | Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet. |
Info_Favorites | Query Smartsheet Favorites. |
Info_Folders | Query Smartsheet Folders in the Sheets Folder for the User, in another Folder, or in a Workspace. |
Info_Groups | Query Smartsheet Groups. |
Info_Home | Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to. |
Info_Reports | Query Smartsheet Reports. |
Info_Rows | Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments. |
Info_ServerInformation | Query Smartsheet Server Information including application constants. |
Info_Shares | Query the Sharing operations of Reports, Sheets, and Workspaces. |
Info_Sheets | 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. |
Info_Templates | Query Smartsheet Templates. |
Info_Users | Query the Users in the organization. |
Info_Workspaces | Query Smartsheet Workspaces. |
Query the available CellHistory of a Cell in Smartsheet.
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'
Name | Type | References | Description |
Value | String | The value of the cell. | |
ModifiedAt | Datetime | The value of the cell. | |
EditorName | String | The name of the user who last modified the cell. | |
EditorEmail | String | The email address of the user who last modified the cell. | |
SheetId | String | The Id of the sheet. | |
RowId | String | The Id of the row. | |
ColumnId | String | The Id of the column. |
Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet.
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'
Name | Type | References | Description |
Id [KEY] | String | The Id of the column that the cell is located in. | |
Value | String | The value of the cell. A string, a number, or a boolean value. | |
DisplayValue | String | Visual representation of cell contents as presented to the user in the UI. | |
ColumnType | String | The type definition on the Column object. | |
Formula | String | The formula for a cell, if set. | |
Format | String | The format descriptor. | |
ConditionalFormat | String | The format descriptor describing the conditional formatting of the cell. | |
Strict | Boolean | Set to false to enable lenient parsing. Defaults to true. This attribute can be specified in a request, but will never be present in a response. | |
SheetId | String | The sheet Id. | |
RowId | String | The row Id. |
Query Smartsheet Columns in a Sheet or Report.
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'
Name | Type | References | Description |
Id [KEY] | String | The column Id. | |
Index | Integer | The column index. | |
Title | String | The column title. | |
Primary | Boolean | Whether the column is the Primary Column. | |
Type | String | The column type. One of the following values: Text_Number, Date, Datetime, Contact_List, Checkbox, Picklist, Duration, Predecessor, Abstract_datetime. | |
OptionsAggregate | String | Array of the options available for the column | |
Hidden | Boolean | Whether the column is hidden. | |
Symbol | String | The column symbol. Possible values for the checkbox column type: star, flag. Possible values for the picklist column type: harvey_balls, priority, ryg, priority_hml, decision_symbols, decision_shapes, vcr, rygb, rygg, weather, progress, arrows_3_way, arrows_4_way, arrows_5_way, directions_3_way, directions_4_way, ski, signal, star_rating, hearts, money, effort, pain. | |
ColumnType | String | The system column type. Possible values: auto_number, modified_date, modified_by, created_date, created_by. | |
TagsAggregate | String | Set of tags to indicate special columns. Each element in the array will be set to one of the following values: calendar_start_date, calendar_end_date, gantt_start_date, gantt_end_date, gantt_percent_complete, gantt_display_label, gantt_predecessor, gantt_duration, gantt_assigned_resource | |
Width | Integer | The display width of the column in pixels. | |
Format | String | The format descriptor. | |
FilterType | String | The filter applied to the column. Possible values: list, custom. | |
Locked | Boolean | Whether the column is locked. A value of true indicates that the column has been locked by the sheet owner or the admin. | |
LockedForUser | Boolean | Whether the column is locked for the requesting user. | |
SheetId | String | The sheet Id. |
Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the contact. | |
Name | String | The full name of the contact. | |
String | The email address of the contac. |
Query Smartsheet Favorites.
This view returns a list of Favorite objects.
Retrieve all Favorite objects.
SELECT * FROM Info_Favorites
Name | Type | References | Description |
ObjectId | String | The unique identifier of the item marked as a favorite. If the favorite type is template, only a private sheet-type template Id is allowed. | |
Type | String | The type of the favorite. Possible values: workspace, folder, sheet, report, template. |
Query Smartsheet Folders in the Sheets Folder for the User, in another Folder, or in a Workspace.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the folder. | |
Name | String | The folder name. | |
Permalink | String | URL that represents a direct link to the Folder in Smartsheet. | |
Favorite | Boolean | Whether the user has marked the Folder as a Favorite in their Home tab. | |
WorkspaceId | String | Id of workspace where this folder is located |
Query Smartsheet Groups.
Retrieve all Groups.
SELECT * FROM Info_Groups
Retrieve details for a Group.
SELECT * FROM Info_Groups WHERE Id='2035256120371076'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the group. | |
Name | String | The name of the group. | |
Description | String | The description of the group. | |
Owner | String | The email address of the group. | |
OwnerId | String | The user Id of the owner of the group. | |
CreatedAt | Datetime | Time of creation. | |
ModifiedAt | Datetime | Time of the last modification. |
Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.
Retrieve all objects located on the Home tab:
SELECT * FROM Info_Home
Name | Type | References | Description |
SheetsAggregate | String | Array of sheet objects. | |
FoldersAggregat | String | Array of folder objects. | |
ReportsAggregat | String | Array of report objects. | |
TemplatesAggregat | String | Array of template objects. | |
WorkspacesAggregat | String | Array of workspace objects. |
Query Smartsheet Reports.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the report. | |
Name | String | The name of the report. | |
FolderId | String | The Id of the folder. | |
WorkspaceId | String | Id of workspace where this report is located |
Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the row. | |
RowNumber | Integer | The row number within the sheet. Starts at 1. | |
Version | Integer | The version number. This is incremented every time a sheet is modified. | |
FilteredOut | Boolean | True if this row is filtered out by a column filter (and thus is not displayed in the Smartsheet app). False if the row is not filtered out. | |
InCriticalPath | Boolean | True if the sheet is a project sheet with dependencies enabled and this row is in the critical path. | |
Locked | Boolean | Whether the row has been locked by the sheet owner or the admin. | |
LockedForUser | Boolean | Whether the row is locked for the requesting user. | |
Expanded | Boolean | Whether the row is expanded or collapsed. | |
AccessLevel | String | The permissions the user has to access the sheet that contains the row. | |
Format | String | The format descriptor. | |
ConditionalFormat | String | The format descriptor for a conditional filter. | |
CreatedAt | Datetime | Time of creation. | |
ModifiedAt | Datetime | Time of the last modification. | |
Permalink | String | URL that represents a direct link to the row in Smartsheet. | |
ParentId | String | The Id of the parent row. | |
SiblingId | String | The Id of the previous sibling row at the same hierarchical level of this row. | |
ToTop | Boolean | Flag used to specify the location for a new or moved row. | |
ToBottom | Boolean | Flag used to specify the location for a new or moved row. | |
Above | Boolean | Flag used to specify the location for a new or moved row. | |
SheetId | String | The Id of the parent sheet. |
Query Smartsheet Server Information including application constants.
Retrieve Server Information:
SELECT * FROM Info_ServerInformation
Name | Type | References | Description |
SupportedLocales | String | Array of strings representing all Smartsheet-supported locales. | |
FormatsDefaults | String | A format descriptor where each element describes the formats the Smartsheet Web application displays for format values that have not been set. | |
FontFamily | String | Font families with additional font information. | |
FontSize | String | Font sizes in points. | |
Bold | String | Specifies bold font. Possible values: none, on. | |
Italic | String | Specifies italic font. Possible values: none, on. | |
Underline | String | Specifies underlined font. Possible values: none, on. | |
Strikethrough | String | Specifies strikethrough font. Possible values: none, on. | |
HorizontalAlign | String | Specifies horizontally aligned text. Possible values: none, on. | |
VerticalAlign | String | Specifies vertically aligned text. Possible values: top, middle, bottom. Note: default is the default value, which is equivalent to top. | |
Color | String | Color hex values. Note: None is the default value for all colors. Applications will need to handle this value and use app-defined colors (typically this is Black for text color and White for background color). | |
Currency | String | Currency codes and symbols. | |
ThousandsSeparator | String | Specifies whether the thousands separator for a number is displayed. Possible values: none, on. | |
NumberFormat | String | The number format. Possible values: none, NUMBER, CURRENCY, PERCENT. | |
TextWrap | String | Whether the text is wrapped. Possible values: none, on. |
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.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the sheet. | |
Name | String | The name of the sheet. | |
Owner | String | Email address of the sheet owner. | |
OwnerId | String | User Id of the Sheet owner. | |
Permalink | String | URL that represents a direct link to the sheet in Smartsheet. | |
SourceId | String | The Id of the Sheet or Template from which the enclosing sheet was created. | |
SourceType | String | The type of the source object. Possible values: sheet or template. | |
CreatedAt | Datetime | Time that the sheet was created. | |
ModifiedAt | Datetime | Time that the sheet was modified. | |
Version | Long | A number that is incremented every time a sheet is modified. | |
TotalRowCount | Long | The total number of rows in the sheet. | |
AccessLevel | String | User permissions on the sheet. | |
ReadOnly | Boolean | Whether the Sheet belongs to an expired trial. | |
GanttEnabled | Boolean | Whether Gantt is enabled. | |
DependenciesEnabled | Boolean | Whether dependencies are enabled. | |
ResourceManagementEnabled | Boolean | Whether resource management is enabled. | |
Favorite | Boolean | Whether the user has marked this sheet as a favorite in their Home tab. | |
ShowParentRowsForFilters | Boolean | Whether the show parent rows option is enabled for the filters. | |
FromId | String | The Id of the Template from which to create the Sheet. | |
WorkspaceId | String | The Id of the workspace. | |
FolderId | String | The Id of the folder. |
Query Smartsheet Templates.
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'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the template. | |
Name | String | The name of the template. | |
Description | String | The description for the template. | |
TemplateType | String | The template type.
使用できる値は次のとおりです。public, user | |
AccessLevel | String | The user permissions on the template. | |
Permalink | String | The permalink for the template. | |
Image | String | The image link for the template. | |
Locale | String | The locale for the template. | |
FolderId | String | The Id of the folder the template is part of. | |
WorkspaceId | String | The Id of the workspace the template is part of. |
Query the Users in the organization.
Retrieve all Users.
SELECT * FROM Info_Users
Retrieve all Users of a specific Group.
SELECT * FROM Info_Users WHERE GroupId='2928085806875091'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the user. | |
AccountId | String | The Id of the associated account. | |
AccountName | String | The name of the associated account. | |
String | The email address of the user. | ||
Name | String | The full name of the user. | |
FirstName | String | The first name of the user. | |
LastName | String | The last name of the user. | |
Admin | Boolean | Whether the user is a system admin. A system admin can manage users and accounts. | |
Locale | String | The locale for the user. | |
TimeZone | String | The timezone for the user. | |
LicensedSheetCreator | Boolean | Whether the user is a licensed user. A licensed user can create and own sheets. | |
GroupAdmin | Boolean | Whether the user is a group admin. A group admin can create and edit groups. | |
ResourceViewer | Boolean | Whether the user is a resource viewer. A resource viewer can access resource views. | |
Status | String | The status of the user. Possible values: ACTIVE, PENDING, DECLINED. | |
GroupId | String | The Id of the group. |
Query Smartsheet Workspaces.
Retrieve all Workspaces.
SELECT * FROM Info_Workspaces
Retrieve all details for a specific Workspace.
SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'
Name | Type | References | Description |
Id [KEY] | String | The unique identifier of the workspace. | |
Name | String | The name of the workspace. | |
Favorite | Boolean | Whether the user has marked the workspace as a Favorite. | |
AccessLevel | String | The access permissions the user has to the Workspace. | |
Permalink | String | URL that represents a direct link to the workspace in Smartsheet. |
The Smartsheet table Report_Sales_Activity_And_Team_Objectives.
Name | Type | References | Description |
Sheet Name | String | The Sheet Name column for the table Report_Sales_Activity_And_Team_Objectives. | |
Primary | String | The Primary column for the table Report_Sales_Activity_And_Team_Objectives. | |
Responsible | String | The Responsible column for the table Report_Sales_Activity_And_Team_Objectives. | |
Pace | String | The Pace column for the table Report_Sales_Activity_And_Team_Objectives. | |
Percent to Goal | String | The Percent to Goal column for the table Report_Sales_Activity_And_Team_Objectives. | |
Due Date | Datetime | The Due Date column for the table Report_Sales_Activity_And_Team_Objectives. | |
Actual | String | The Actual column for the table Report_Sales_Activity_And_Team_Objectives. | |
Quota | String | The Quota column for the table Report_Sales_Activity_And_Team_Objectives. | |
Comments | String | The Comments column for the table Report_Sales_Activity_And_Team_Objectives. | |
State | String | The State column for the table Report_Sales_Activity_And_Team_Objectives. |
Query the Report_Tasks_and_Events view in Smartsheet.
Name | Type | References | Description |
RowId [KEY] | String | This column is dynamic and maps to the corresponding field in the API. | |
Sheet Name | String | This column is dynamic and maps to the corresponding field in the API. | |
Primary | String | This column is dynamic and maps to the corresponding field in the API. | |
Assigned To | String | This column is dynamic and maps to the corresponding field in the API. | |
Comments | String | This column is dynamic and maps to the corresponding field in the API. | |
Status | String | This column is dynamic and maps to the corresponding field in the API. | |
Due | Datetime | This column is dynamic and maps to the corresponding field in the API. | |
Due Date | Datetime | This column is dynamic and maps to the corresponding field in the API. | |
Budget | String | This column is dynamic and maps to the corresponding field in the API. | |
Assigned | String | This column is dynamic and maps to the corresponding field in the API. | |
Actual | String | This column is dynamic and maps to the corresponding field in the API. | |
Notes & Comments | String | This column is dynamic and maps to the corresponding field in the API. | |
Reviewed | Boolean | This column is dynamic and maps to the corresponding field in the API. | |
Progress | String | This column is dynamic and maps to the corresponding field in the API. |
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
Smartsheet | CData スキーマ |
Auto-Number | int |
Checkbox | bool |
Contact list | string |
Created (Date) | datetime |
Created By | string |
Date | date |
Dropdown List | string |
Modified (Date) | datetime |
Modified By | string |
Symbols (Flag/Star) | bool |
Symbols (Dropdowns) | string |
Text/Number (Text) | string |
Text/Number (Whole Number) | int (<2,147,483,647) or long (>2,147,483,647) |
Text/Number (Decimal) | float |
プロパティ | 説明 |
AuthScheme | Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet |
PersonalAccessToken | The Personal Access Token that can be generated from the Smartsheet UI. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
Header | Indicates whether or not the provider should detect column names from the first row. |
HideFormattingCharacters | 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. |
IgnoreRowsNotFound | 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. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Smartsheet から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ReportCompatibilityLevel | 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) |
RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TypeDetectionScheme | Determines how to determine the data types of columns. |
UseFullFilePathsAsTableNames | Whether or not to include the full file path in the name of an exposed table or view, corresponding to a sheet or report. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
ValueSource | Indicates whether the cell will use the Value fields as its value or the DisplayValue field. |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet |
PersonalAccessToken | The Personal Access Token that can be generated from the Smartsheet UI. |
Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet
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.
The Personal Access Token that can be generated from the Smartsheet UI.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はSmartsheet への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Smartsheet Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
Header | Indicates whether or not the provider should detect column names from the first row. |
HideFormattingCharacters | 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. |
IgnoreRowsNotFound | 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. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Smartsheet から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ReportCompatibilityLevel | 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) |
RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TypeDetectionScheme | Determines how to determine the data types of columns. |
UseFullFilePathsAsTableNames | Whether or not to include the full file path in the name of an exposed table or view, corresponding to a sheet or report. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
ValueSource | Indicates whether the cell will use the Value fields as its value or the DisplayValue field. |
Indicates whether or not the provider should detect column names from the first row.
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 Sync App will follow the additional specifications below to detect column headers:
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.
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.
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.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Smartsheet から返されるページあたりの結果の最大数。
Pagesize プロパティは、Smartsheet から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
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)
The minimum level required to get data for 'report' tables is 2.
テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。
大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
Determines how to determine the data types of columns.
None | Setting TypeDetectionScheme to None will return all columns as the string type. Note: Even when set to None, the column names will still be scanned when Header is set to True. |
RowScan | Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned. |
Whether or not to include the full file path in the name of an exposed table or view, corresponding to a sheet or report.
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.
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Sheet_Test_Sheet WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Smartsheet テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。
Indicates whether the cell will use the Value fields as its value or the DisplayValue field.