CData Sync App は、Microsoft SharePoint データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Microsoft SharePoint コネクタはCData Sync アプリケーションから使用可能で、Microsoft SharePoint からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、SOAP API をサポートするMicrosoft SharePoint のすべてのバージョンをサポートします。これには、Windows SharePoint Services 3.0、SharePoint Server 2007+ (2010, 2013, etc.)、およびSharePoint Online が含まれます。Sync App は、SharePoint のカスタムリストを双方向アクセス可能なテーブルとしてモデル化します。接続時に、Sync App はSharePoint Web サービスを呼び出してこれらのテーブルのメタデータを取得します。サポートされる認証スキーマはNTLM、Basic、Digest、Forms、Kerberos、SSO、STS (security token services)、およびSharePoint 認証クッキーです。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
URL の設定:
Microsoft SharePoint は、グローバルなMicrosoft SharePoint サイト内のすべてのリストとドキュメント、または個々のサイトのすべてのリストとドキュメントで機能します。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティをサイトコレクションURL に設定します。次に例を示します。
https://teams.contoso.com
個々のサイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティを個々のサイトURL に設定します。次に例を示します。
https://teams.contoso.com/TeamA
以下のセクションでは、使用環境に適した認証プロパティの設定方法について説明します。カスタムOAuth アプリケーション(Web アプリケーションでAzureAD を使用する場合は必須、デスクトップアプリケーションまたはヘッドレスサーバー経由でAzureAD にアクセスする場合はオプション)の作成については、カスタムOAuth アプリケーションの作成 を参照してください。
SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。
Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。
もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。
Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。
AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。
AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
AuthScheme をOkta に設定します。Okta に接続するには、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
AuthScheme をPingFederate に設定します。PingFederate への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity(MSI)の資格情報を利用して接続が可能です。
MSI 資格情報が認証用に自動的に取得されます。
AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。
AuthScheme をSharePointOAuth に設定します。SharePointOAuth への接続には、次の接続プロパティを使用します。
接続文字列の例:
SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;このAuthScheme はカスタムOAuth アプリケーションで動作します。カスタムOAuth アプリケーションから認証情報を生成するには、カスタムOAuth アプリケーションの作成 を参照してください。
Microsoft SharePoint REST API はSharePoint OnPremise とSharePoint Online の両方でサポートされています。REST API を使用して接続するには、Schema をREST に設定してください。
SharePointEdition プロパティは、SharePoint のエディションの定義に使用できます。
SharePoint Online はOAuth 標準を使用して認証します。詳しくは、接続の確立 の「SharePoint Online への認証」の手順でご確認ください。
詳しくは、接続の確立 の「SharePoint On Premises への認証」の手順でご確認ください。
Kerberos でMicrosoft SharePoint への認証を行うには、AuthScheme をNEGOTIATE に設定します。
Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。
Sync App は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。
MIT Kerberos 資格情報キャッシュファイル
このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。
このオプションは、KRB5CCNAME がシステムに作成されている必要があります。
MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:
チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。
Sync App はキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。
Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Sync App は指定されたキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。
Keytab ファイル
お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。
この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。
User およびPassword
お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。
この方法を使用するには、User およびPassword プロパティを、Microsoft SharePoint での認証に使用するユーザー / パスワードの組み合わせに設定します。
このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。
高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。
このセクションでは、Microsoft SharePoint Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Microsoft SharePoint にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Microsoft SharePoint Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
Sync App は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。
Sync App は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。
一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。
リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。
SELECT * FROM ListName WHERE ViewID='ID of the view'Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。
SELECT * FROM Views WHERE List ='ListName'
Sync App はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Attachments | Reads or deletes attachments to the specified item on the specified list. |
Groups | Creates, updates, deletes, and queries Groups from SharePoint. |
Roles | Creates, updates, deletes, and queries Roles from SharePoint. |
Users | Updates, deletes, and queries Users from SharePoint. |
Views | Creates, updates, deletes, and queries the available lists in SharePoint. |
Reads or deletes attachments to the specified item on the specified list.
Attachment を戻すにはリストとリストID が必要です。
リスト項目に新しい添付ファイルを追加するには、AddAttachments ストアドプロシージャを呼び出します。
Name | Type | ReadOnly | Description |
Url [KEY] | String | True |
Description of the term set. |
List | String | True |
The internal name of the list to retrieve attachments from. |
ListDisplayName | String | True |
The display name of the list to retrieve attachments from. |
ItemID | String | True |
The Id of the item on the list to retrieve attachments from. |
Name | String | True |
The name of the attachment on the item. |
Creates, updates, deletes, and queries Groups from SharePoint.
このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。
UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。
Name | Type | ReadOnly | Description |
Name# [KEY] | String | False |
The name of the group. |
Description# | String | False |
A description of the group. |
OwnerLogin# | String | False |
The user name of the owner of the group. This value should be in the format DOMAIN\\username. |
OwnerType# | String | False |
The type of owner. User or group. |
DefaultLogin# | String | False |
The user name of the default user for the group. This value should be in the format DOMAIN\\username. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
UserName | String |
The logical name of the user to return groups for. Specify this value on the SELECT statement to return only groups the specified User is in. |
Creates, updates, deletes, and queries Roles from SharePoint.
UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。
Role を挿入するには、最低でもName が必要です。
INSERT INTO Roles (Name) VALUES ('My Role')
Name | Type | ReadOnly | Description |
Name# [KEY] | String | False |
The name of the role. |
Description# | String | False |
A description of the role. |
Permissions# | Long | False |
A long representing the permissions for the role. |
RoleType | String | True |
The type of role. |
IsHidden | Boolean | True |
A boolean indicating if the role is hidden. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
UserName | String |
The login name of the user to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified user. |
GroupName | String |
The name of the group to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified group. |
Updates, deletes, and queries Users from SharePoint.
SharePoint Account のために作成されたすべてのユーザーを取得する:
SELECT * FROM Users
1つのグループに所属するすべてのユーザーを取得することも可能です。その場合には、Group Name を指定します。
SELECT * FROM Users WHERE [Group] = "GroupName"
指定されたロールを持つユーザーを取得することも可能です。その場合には、Role Name を指定します。
SELECT * FROM Users WHERE [Role] = "RoleName"
Name | Type | ReadOnly | Description |
ID | String | True |
The Id of the user. |
LoginName# [KEY] | String | False |
The login name of the user. |
Name# | String | False |
The name of the user. |
Email# | String | False |
The email address of the user. |
IsInDomainGroup | Boolean | True |
A boolean indicating if the user is in the domain group. |
IsSiteAdmin | Boolean | True |
A boolean indicating if the user is a site admin. |
Notes# | String | False |
Optional notes concerning the user. |
SecurityId | String | True |
The security Id (SID) for the user. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Group | String |
The group you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but you can optionally specify deletions. |
Role | String |
The role you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but but you can optionally specify deletions. |
Creates, updates, deletes, and queries the available lists in SharePoint.
Views は特別なテーブルです。これを使用して、指定されたリストのビューを取得、更新、挿入、および削除できます。
SELECT * FROM Views WHERE List = 'MyListName'
このテーブルに挿入するにはList、Name、Type、およびFields カラムが必要です。
Name | Type | ReadOnly | Description |
ID [KEY] | String | True |
The Id of the view. |
List | String | True |
The list the view is associated with. A list must be specified when performing SELECT statements if the Id is not specified. |
ViewID | String | True |
The Id of the view. May only be unique for the specific list. |
Name | String | False |
The name of the view. |
Type | String | False |
The type of view. This must have a value on inserts and updates. 使用できる値は次のとおりです。CALENDAR, GRID, HTML デフォルト値はHTMLです。 |
Fields | String | False |
A comma-separated list of the fields associated with the view. This is space-sensitive. |
IsDefault | Boolean | False |
A boolean indicating if the view is the default view for the list. |
Query | String | False |
A query for the view. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
FileVersions | Lists the versions of files available on SharePoint. |
GetValidTerms | Gets a list of valid terms for the specified column on the specified table. |
Lists | Lists the available lists in SharePoint. |
Permissions | The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID. |
Subsites | Lists the available subsites. |
Lists the versions of files available on SharePoint.
このビューから結果を返すには、Library およびFile を指定する必要があります。
Name | Type | Description |
ID [KEY] | String | The Id of the version. |
Comments | String | Comments about the particular version. |
CreateBy | String | The username of the SharePoint user who modified this version of the file. |
Date | Datetime | When the file was modified. |
Size | String | The size of this version of the file. |
Url | String | The URL to this version of the file. |
Library | String | The library name on SharePoint you are listing versions from. A library must be specified to retrieve the versions for a file.
デフォルト値はShared Documentsです。 |
File | String | The name of the file on SharePoint to list versions for. You must specify a file to retrieve the versions for a file. |
Gets a list of valid terms for the specified column on the specified table.
GetValidTerms は特別なビューです。これを使用して、特定のリストの分類列または管理されたメタデータ列に対して有効な用語を取得できます。このビューを使用するには、テーブルの名前と、有効な用語の取得元になる列を指定します。次に例を示します。
SELECT * FROM GetValidTerms WHERE List = 'MyListName' AND ColumnName = 'MyManagedMetadataColumn'
Name | Type | Description |
ID [KEY] | String | The identifier of the term. |
TermLabelValue | String | The label of the term. |
Description | String | Description of the term set. |
NameInRequestedLang | String | The name of the term set in the language requested by the client. |
IsOpen | Boolean | A Boolean indicating if the term set is open. |
Deprecated | Boolean | A Boolean indicating if the term is deprecated. |
InternalId | String | An internal identifier for the term. |
TermSetContact | String | The term set contact. |
ContainerDesc | String | The container node for the description. |
SingleTermLabelDesc | String | This fully describes a single term label. |
IsDefaultLabel | Boolean | True if the term label is the default term label. |
BelongsTo | String | This item describes a term set to which a term belongs. |
IsTaggingAvailable | Boolean | If the term set is available for tagging, this value is true. |
TermPath | String | Term path of the term with term labels. |
TermpathoftermwithIds | String | Term path of term with identifiers. |
ChildTerms | String | A string value that indicates a custom sort order for the child terms of the term identified by PertainingToTerm. |
HasChildTerms | Boolean | True if the term has child terms. |
PertainingToTerm | String | An identifier of the term that this term set information is pertaining to. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
List | String | The name of the list to get valid terms for. |
ColumnName | String | The name of the column to get valid terms for. |
LocaleId | String | The locale Id for the term. Defaults to 1033. |
Lists the available lists in SharePoint.
Lists を使用して、SharePoint のテーブルをリストできます。これは、SharePoint 内の実際のリストだけを返します。Sync App に関連付けられた特別なテーブルは返しません。
WHERE 句で次の列を使用できます:Title およびBaseTemplage。
Name | Type | Description |
ID [KEY] | String | The Id of the list. |
Title | String | The title of the list. This column may be used in the WHERE clause and may be used with a wild card (*) character. |
Description | String | A description for the list. |
BaseTemplate | String | Indicates the type of template used to create the list. This column may be used in the WHERE clause. |
Version | Double | The version of the list. |
Url | String | The default URL of the list. |
EmailAlias | String | The email alias of the list. |
ImageUrl | String | The image URL of the list. |
ItemCount | Integer | The number of items in the list. |
Item_Deleted | Datetime | The last time an item was deleted from this list. |
Item_Modified | Datetime | The last time an item was modified from this list. |
SendToUrl | String | The send-to URL of the list. |
Created | Datetime | The time when the list was created. |
AllowDeletion | String | Whether items can be deleted. |
AllowMultiResponses | Boolean | A Boolean indicating if multiple responses are enabled for the survey. |
Direction | String | A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left, or None. |
EnableAssignedToEmail | Boolean | A Boolean indicating if assigned-to emails are enabled. Only applies to issues lists. |
EnableAttachments | Boolean | A Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries. |
EnableModeration | Boolean | A Boolean indicating if content approval is enabled for the list. |
EnableVersioning | Boolean | A Boolean indicating if versioning is enabled for the list. |
Hidden | Boolean | A Boolean indicating if the list is hidden so that it does not appear on the Documents and Lists page, Quick Launch bar, Modify Site Content page, or Add Column page as an option for lookup fields. |
MultipleDataList | Boolean | A Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site. |
Ordered | Boolean | A Boolean indicating if items in the list can be sorted on the Edit View page. |
Showuser | Boolean | A Boolean indicating if the names of users are shown in the results of the survey. |
The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID.
Name | Type | Description |
MemberID [KEY] | String | The Id of the permission. |
Mask | Long | A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ('|') in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions. |
MemberIsUser | Bool | Indicate whether it is the permission for user. |
MemberGlobal | Bool | Indicate whether it is the permission for group. |
RoleName | String | A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ObjectName | String | A string that contains the name of the list or site. |
ObjectType | String | A string that specifies either List or Web. |
ItemID | String | Id of the item. |
Lists the available subsites.
Name | Type | Description |
Title | String | The name of the subsite. |
Url | String | The url of the subsite. |
CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。
ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。
NOTE: "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に
$select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Attachments | Reads attachments for the specified item on the specified list. |
Files | Query the available files on your sharepoint site. |
Groups | Query the available groups on your sharepoint site. |
Lists | Query the available lists on your sharepoint site. |
RoleAssignmentMember | Get Web RoleAssignments member. |
RoleAssignments | Get Web RoleAssignments. |
RoleDefinitionBindings | Get Web Role definition binding. |
Roles | Query the roles your users can have. |
Subsites | This lists the available subsites. |
Users | Query the available users on your sharepoint site. |
Reads attachments for the specified item on the specified list.
Note: List and ItemId are required to return Attachments.
List can be fetched from the Lists view(Title column).
SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1
Name | Type | References | Description |
Id [KEY] | String | The Id of the attachment on the item. | |
Updated | Datetime | The updated date of the attachment to the item. | |
FileName | String | The FileName of the attachment to the item. | |
ServerRelativePath_DecodedUrl | String | The ServerRelativePath DecodedUrl of the attachment to the item. | |
FileNameAsPath_DecodedUrl | String | The FileNameAsPath DecodedUrl of the attachment to the item. | |
ServerRelativeUrl | String | The ServerRelativeUrl of the attachment to the item. | |
List | String | The internal name of the list to retrieve attachments from. | |
ItemID | String | The Id of the item on the list to retrieve attachments from. |
Query the available files on your sharepoint site.
Name | Type | References | Description |
Id [KEY] | String | ||
CreatedBy_Id | String | ||
CreatedBy_Name | String | ||
CreatedBy_Puid | String | ||
ETag | String | ||
LastModifiedBy_Id | String | ||
LastModifiedBy_Name | String | ||
LastModifiedBy_Puid | String | ||
Name | String | ||
Size | Int | ||
TimeCreated | Datetime | ||
TimeLastModified | Datetime | ||
Url | String |
Query the available groups on your sharepoint site.
SELECT * FROM Groups
Name | Type | References | Description |
Id [KEY] | Int | The Group Id. | |
AllowMembersEditMembership | Bool | ||
AllowRequestToJoinLeave | Bool | ||
AutoAcceptRequestToJoinLeave | Bool | ||
CanCurrentUserEditMembership | Bool | ||
CanCurrentUserManageGroup | Bool | ||
CanCurrentUserViewMembership | Bool | ||
Description | String | ||
OnlyAllowMembersViewMembership | Bool | ||
OwnerTitle | String | ||
RequestToJoinLeaveEmailSetting | String | ||
LinkedOwner | String | ||
LinkedUsers | String |
Query the available lists on your sharepoint site.
Name | Type | References | Description |
HasUniqueRoleAssignments [KEY] | Bool | ||
LinkedFirstUniqueAncestorSecurableObject | String | ||
LinkedRoleAssignments | String | ||
ServerRelativeUrl | String | The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite. | |
Id [KEY] | String | ||
AllowContentTypes | Bool | ||
AllowDeletion | Bool | ||
BaseTemplate | Int | ||
BaseType | Int | ||
BrowserFileHandling | Int | ||
ContentTypesEnabled | Bool | ||
CrawlNonDefaultViews | Bool | ||
Created | Datetime | ||
CurrentChangeToken_StringValue | String | ||
CustomActionElements_Items | String | ||
DataSource_Properties | String | ||
DefaultContentApprovalWorkflowId | String | ||
DefaultDisplayFormUrl | String | ||
DefaultEditFormUrl | String | ||
DefaultItemOpenUseListSetting | Bool | ||
DefaultNewFormUrl | String | ||
DefaultViewPath_DecodedUrl | String | ||
DefaultViewUrl | String | ||
Description | String | ||
Direction | String | ||
DisableGridEditing | Bool | ||
DocumentTemplateUrl | String | ||
DraftVersionVisibility | Int | ||
EffectiveBasePermissions_High | Long | ||
EffectiveBasePermissions_Low | Long | ||
EffectiveBasePermissionsForUI_High | Long | ||
EffectiveBasePermissionsForUI_Low | Long | ||
EnableAssignToEmail | Bool | ||
EnableAttachments | Bool | ||
EnableFolderCreation | Bool | ||
EnableMinorVersions | Bool | ||
EnableModeration | Bool | ||
EnableRequestSignOff | Bool | ||
EnableVersioning | Bool | ||
EntityTypeName | String | ||
ExcludeFromOfflineClient | Bool | ||
ExemptFromBlockDownloadOfNonViewableFiles | Bool | ||
FileSavePostProcessingEnabled | Bool | ||
ForceCheckout | Bool | ||
HasExternalDataSource | Bool | ||
Hidden | Bool | ||
ImagePath_DecodedUrl | String | ||
ImageUrl | String | ||
IrmEnabled | Bool | ||
IrmExpire | Bool | ||
IrmReject | Bool | ||
IsApplicationList | Bool | ||
IsCatalog | Bool | ||
IsEnterpriseGalleryLibrary | Bool | ||
IsPrivate | Bool | ||
IsSiteAssetsLibrary | Bool | ||
IsSystemList | Bool | ||
ItemCount | Int | ||
LastItemDeletedDate | Datetime | ||
LastItemModifiedDate | Datetime | ||
LastItemUserModifiedDate | Datetime | ||
ListExperienceOptions | Int | ||
ListItemEntityTypeFullName | String | ||
MajorVersionLimit | Int | ||
MajorWithMinorVersionsLimit | Int | ||
MultipleDataList | Bool | ||
NoCrawl | Bool | ||
OnQuickLaunch | Bool | ||
PageRenderType | Int | ||
ParentWebPath_DecodedUrl | String | ||
ParentWebUrl | String | ||
ParserDisabled | Bool | ||
ReadSecurity | Int | ||
SchemaXml | String | ||
ServerTemplateCanCreateFolders | Bool | ||
TemplateFeatureId | String | ||
Title | String | ||
ValidationFormula | String | ||
ValidationMessage | String | ||
WriteSecurity | Int | ||
LinkedContentTypes | String | ||
LinkedCreatablesInfo | String | ||
LinkedDefaultView | String | ||
LinkedDescriptionResource | String | ||
LinkedEventReceivers | String | ||
LinkedFields | String | ||
LinkedForms | String | ||
LinkedInformationRightsManagementSettings | String | ||
LinkedItems | String | ||
LinkedParentWeb | String | ||
LinkedRootFolder | String | ||
LinkedSubscriptions | String | ||
LinkedTitleResource | String | ||
LinkedUserCustomActions | String | ||
LinkedViews | String | ||
LinkedWorkflowAssociations | String |
Get Web RoleAssignments member.
Note: PrincipalId is required to return RoleAssignmentMember.
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned member. | |
Updated | Datetime | The updated date for role assigned member. | |
IsHiddenInUI | Boolean | A boolean indicating if the assigned role member is hidden in UI. | |
LoginName | String | The login name of the role assigned member. | |
Title | String | The title of the role assigned member. | |
AllowMembersEditMembership | Boolean | A boolean indicating whether to allow members edit membership. | |
AllowRequestToJoinLeave | Boolean | A boolean indicating whether to allow request to join leave. | |
AutoAcceptRequestToJoinLeave | Boolean | A boolean indicating whether to auto accept request to join leave. | |
Description | String | The description of the role assigned member. | |
OnlyAllowMembersViewMembership | Boolean | A boolean indicating whether to only allow members view membership. | |
OwnerTitle | String | The owner title of the role assigned member. | |
RequestToJoinLeaveEmailSetting | String | The request to join leave email setting of the role assigned member. | |
PrincipalId | String |
RoleAssignments.PrincipalId | The Principal Id. |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned member from. |
ItemId | String | List item id for role assignment. |
Get Web RoleAssignments.
SELECT * FROM RoleAssignments WHERE List = 'TestApp' SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned. | |
PrincipalId | Long | The Principal ID for role assigned. | |
Updated | Datetime | The updated date for role assigned. | |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned from. |
ItemId | String | List item id for role assignment. |
Get Web Role definition binding.
NOTE: PrincipalId is required to return RoleDefinitionBindings.
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned member. | |
BasePermissions_High | Int64 | The base permissions high. | |
BasePermissions_Low | Int64 | The base permissions low. | |
Description | String | The description. | |
Hidden | Boolean | A boolean indicating if it is hidden. | |
Name | String | The name. | |
Order | Int | The order. | |
RoleTypeKind | Int | The role type kind. | |
PrincipalId | String |
RoleAssignments.PrincipalId | The Principal Id. |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned member from. |
ItemId | String | List item id for role defintion. |
Query the roles your users can have.
Name | Type | References | Description |
Id [KEY] | Int | ||
BasePermissions_High | Long | ||
BasePermissions_Low | Long | ||
Description | String | ||
Hidden | Bool | ||
Name | String | ||
Order | Int | ||
RoleTypeKind | Int |
This lists the available subsites.
SELECT * FROM Subsites
Name | Type | References | Description |
Id [KEY] | String | The Id of the subsite. | |
AllowRssFeeds | Boolean | The AllowRssFeeds of the subsite. | |
AlternateCssUrl | String | The AlternateCssUrl of the subsite. | |
AppInstanceId | String | The AppInstanceId of the subsite. | |
ClassicWelcomePage | String | The ClassicWelcomePage of the subsite. | |
Configuration | Int | The Configuration of the subsite. | |
Created | Datetime | The Created of the subsite. | |
CurrentChangeToken_StringValue | String | The CurrentChangeToken_StringValue of the subsite. | |
CustomMasterUrl | String | The CustomMasterUrl of the subsite. | |
Description | String | The Description of the subsite. | |
DesignPackageId | String | The DesignPackageId of the subsite. | |
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled | Boolean | The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite. | |
EnableMinimalDownload | Boolean | The EnableMinimalDownload of the subsite. | |
FooterEmphasis | Int | The FooterEmphasis of the subsite. | |
FooterEnabled | Boolean | The FooterEnabled of the subsite. | |
FooterLayout | Int | The FooterLayout of the subsite. | |
HeaderEmphasis | Int | The HeaderEmphasis of the subsite. | |
HeaderLayout | Int | The HeaderLayout of the subsite. | |
HideTitleInHeader | Boolean | The HideTitleInHeader of the subsite. | |
HorizontalQuickLaunch | Boolean | The HorizontalQuickLaunch of the subsite. | |
IsHomepageModernized | Boolean | The IsHomepageModernized of the subsite. | |
IsMultilingual | Boolean | The IsMultilingual of the subsite. | |
IsRevertHomepageLinkHidden | Boolean | The IsRevertHomepageLinkHidden of the subsite. | |
KeepFieldUserResources | Boolean | The KeepFieldUserResources of the subsite. | |
Language | Int | The Language of the subsite. | |
LastItemModifiedDate | Datetime | The LastItemModifiedDate of the subsite. | |
LastItemUserModifiedDate | Datetime | The LastItemUserModifiedDate of the subsite. | |
LogoAlignment | Int | The LogoAlignment of the subsite. | |
MasterUrl | String | The MasterUrl of the subsite. | |
MegaMenuEnabled | Boolean | The MegaMenuEnabled of the subsite. | |
NavAudienceTargetingEnabled | Boolean | The NavAudienceTargetingEnabled of the subsite. | |
NoCrawl | Boolean | The NoCrawl of the subsite. | |
ObjectCacheEnabled | Boolean | The ObjectCacheEnabled of the subsite. | |
OverwriteTranslationsOnChange | Boolean | The OverwriteTranslationsOnChange of the subsite. | |
ResourcePath_DecodedUrl | String | The ResourcePath_DecodedUrl of the subsite. | |
QuickLaunchEnabled | Boolean | The QuickLaunchEnabled of the subsite. | |
RecycleBinEnabled | Boolean | The RecycleBinEnabled of the subsite. | |
SearchScope | Int | The SearchScope of the subsite. | |
ServerRelativeUrl | String | The ServerRelativeUrl of the subsite. | |
SiteLogoUrl | String | The SiteLogoUrl of the subsite. | |
SyndicationEnabled | Boolean | The SyndicationEnabled of the subsite. | |
TenantAdminMembersCanShare | Int | The TenantAdminMembersCanShare of the subsite. | |
Title | String | The Title of the subsite. | |
TreeViewEnabled | Boolean | The TreeViewEnabled of the subsite. | |
UIVersion | Int | The UIVersion of the subsite. | |
UIVersionConfigurationEnabled | Boolean | The UIVersionConfigurationEnabled of the subsite. | |
Url | String | The Url of the subsite. | |
WebTemplate | String | The WebTemplate of the subsite. | |
WelcomePage | String | The WelcomePage of the subsite. |
Query the available users on your sharepoint site.
SELECT * FROM Users // Fetch all the Users SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group
Name | Type | References | Description |
AadObjectId_NameId | String | ||
AadObjectId_NameIdIssuer | String | ||
String | |||
Expiration | String | ||
IsEmailAuthenticationGuestUser | Bool | ||
IsShareByEmailGuestUser | Bool | ||
IsSiteAdmin | Bool | ||
UserId_NameId | String | ||
UserId_NameIdIssuer | String | ||
UserPrincipalName | String | ||
LinkedAlerts | String | ||
LinkedGroups | String | ||
LoginName | String | The login name of the user. | |
Title | String | The Title of the user. | |
IsHiddenInUI | Boolean | A boolean indicating if the user is hidden in UI. | |
GroupId | Int | The group id the user is added to. |
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
Microsoft SharePoint | CData Schema |
Choice (menu) | string |
Currency | float |
Date and Time | datetime |
Hyperlink or Picture | string |
Lookup | string |
Multiple lines of text | string |
Number | float |
Person or Group | string |
Single line of text | string |
Task Outcome | string |
Yes/No | bool |
プロパティ | 説明 |
AuthScheme | SharePoint への認証に使用されるスキーム。 |
URL | サイトのベースURL。 |
SharePointEdition | 使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。 |
User | 認証で使用されるSharePoint ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
プロパティ | 説明 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSODomain | シングルサインオン(SSO)を使用する場合のユーザーのドメイン。 |
SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | The scope used for the OAuth flow to access data from the Application. |
State | 追加のOAuth ステート情報を表すオプションの値。 |
OAuthGrantType | OAuth フローのグラント種別。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
プロパティ | 説明 |
KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 |
KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 |
KerberosKeytabFile | Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 |
KerberosServiceRealm | サービスのKerberos レルム。 |
KerberosServiceKDC | サービスのKerberos KDC。 |
KerberosTicketCache | MIT Kerberos 資格情報キャッシュファイルへのフルパス。 |
プロパティ | 説明 |
SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 |
SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
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 です。 |
Schema | 使用するスキーマの種類。 |
プロパティ | 説明 |
CalculatedDataType | 計算フィールドで使用されるデータ型。 |
ContinueOnError | エラー後にバッチ内の項目の更新を続行するかどうかを示します。 |
CreateIDColumns | 他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成するかしないかを示します。 |
DisableFilterLimit | Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Enable this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. |
FolderOption | 結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。 |
IncludeLookupColumns | このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Microsoft SharePoint から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ShowHiddenColumns | 非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。 |
ShowPredefinedColumns | 定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 |
ShowVersionViews | リストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。 |
STSURL | シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseDisplayNames | API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。 |
UseEntityTypeName | Boolean determining if the table name should be EntityTypeName instead of the title in the REST schema. |
UseNTLMV1 | ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |