Cloud

Build 24.0.9175
  • Microsoft SharePoint
    • はじめに
      • 接続の確立
      • Kerberos の使用
      • データアクセスのファインチューニング
      • SSL の設定
      • ファイアウォールとプロキシ
    • SOAP データモデル
      • データタイプマッピング
      • テーブル
        • Attachments
        • Groups
        • Roles
        • Users
        • Views
      • ビュー
        • FileVersions
        • GetValidTerms
        • Lists
        • Permissions
        • Subsites
      • ストアドプロシージャ
        • AddAttachment
        • AddList
        • AddListColumn
        • AddUserToGroup
        • AddUserToRole
        • CheckInDocument
        • CheckOutDocument
        • CopyDocument
        • CreateFolder
        • DeleteAttachment
        • DeleteDocument
        • DeleteList
        • DeleteListColumn
        • DeleteUserFromGroup
        • DeleteUserFromRole
        • DiscardCheckOutDocument
        • MoveAttachmentOrDocument
        • RenameAttachmentOrDocument
        • UpdateList
        • UpdateListColumn
    • REST データモデル
      • データタイプマッピング
      • ビュー
        • Attachments
        • Comments
        • Files
        • Groups
        • Lists
        • ListItems
        • RoleAssignmentMember
        • RoleAssignments
        • RoleDefinitionBindings
        • Roles
        • Subsites
        • Users
      • ストアドプロシージャ
        • AddAttachment
        • AddImage
        • AddList
        • AddListColumn
        • AddRoleAssignment
        • BreakRoleInheritance
        • CheckInDocument
        • CheckOutDocument
        • CopyDocument
        • CreateFolder
        • DeleteAttachment
        • DeleteDocument
        • DeleteList
        • DeleteListColumn
        • DiscardCheckOutDocument
        • GetAdminConsentURL
        • GetCurrentUser
        • MoveAttachmentOrDocument
        • RemoveRoleAssignment
        • RenameAttachmentOrDocument
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • URL
        • SharePointEdition
        • User
        • Password
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • SSO
        • SSOLoginURL
        • SSODomain
        • SSOProperties
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
        • State
        • OAuthGrantType
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTIssuer
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
        • Schema
      • Miscellaneous
        • CalculatedDataType
        • ContinueOnError
        • CreateIDColumns
        • DisableFilterLimit
        • FolderOption
        • GetColumnsMetadata
        • IncludeLookupColumns
        • IncludeLookupDisplayValueColumns
        • MaxRows
        • Pagesize
        • PseudoColumns
        • ShowHiddenColumns
        • ShowPredefinedColumns
        • ShowVersionViews
        • STSURL
        • Timeout
        • UseDisplayNames
        • UseEntityTypeName
        • UseNTLMV1
        • UseSimpleNames

Microsoft SharePoint - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMicrosoft SharePoint へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMicrosoft SharePoint に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Microsoft SharePoint への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Microsoft SharePoint は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのMicrosoft SharePoint への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Microsoft SharePoint への接続

接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft SharePoint への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してMicrosoft SharePoint からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Microsoft SharePoint に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Microsoft SharePoint への接続

オンラインまたはオンプレミスのどちらで接続するか、どのようなアーキテクチャを使用するか、どのリストやドキュメントにアクセスするかに関わらず、Microsoft SharePoint への接続には次の2つの設定が必要です。
  • URL 接続プロパティを設定します。
  • 使用環境に適した認証プロパティを設定します。

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 アプリケーションの作成 を参照してください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。

Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。

  • AzureAD
  • ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
  • Azure MSI
  • Azure パスワード
  • OAuthJWT
  • SharePointOAuth

もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。

AzureAD

Azure Active Directory(AzureAD)は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft SharePoint との通信を要求します。下記で説明するとおり、本ドライバーはさまざまな方法でこれをサポートします。AuthScheme をAzureAD に設定します。以下で説明するAzure AD フローは、すでに設定済みであることを前提として書かれています。

Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。

シングルサインオンID プロバイダー

ADFS

AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。

  • User:ADFS ユーザー。
  • Password:ユーザーのADFS パスワード。
  • SSODomain(オプション):ADFS のID プロバイダーで設定されたドメイン。
接続文字列の例:
AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
Okta

AuthScheme をOkta に設定します。Okta に接続するには、次の接続プロパティを使用します。

  • User:Okta ユーザー。
  • Password:ユーザーのOkta パスワード。
  • SSODomain(オプション):Okta のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
OneLogin

AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。

  • User:OneLogin ユーザー。
  • Password:ユーザーのOneLogin パスワード。
  • SSODomain(オプション):OneLogin のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
PingFederate

AuthScheme をPingFederate に設定します。PingFederate への接続には、次の接続プロパティを使用します。

  • User:PingFederate ユーザー。
  • Password:ユーザーのPingFederate パスワード。
  • SSODomain(オプション):PingFederate のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';

Azure MSI

Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity(MSI)の資格情報を利用して接続が可能です。

  • AuthScheme:AzureMSI。

MSI 資格情報が認証用に自動的に取得されます。

Azure パスワード

Azure 資格情報を使用して直接接続するには、次の接続プロパティを指定します。
  • AuthScheme: AzurePassword
  • User:Azure への接続に使用するユーザーアカウント
  • Password:Azure への接続に使用するパスワード
  • AzureTenant:Azure 上のMicrosoft SharePoint への認証に使用するOAuth アプリケーションの概要ページにある、Directory (tenant) ID。

OAuthJWT 証明書

AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。

  • AzureTenant:接続するテナント。
  • OAuthJWTCert:JWT 証明書のストア。
  • OAuthJWTCertType:JWT 証明書を格納するキーストアの種類。
  • OAuthJWTIssuer:OAuth クライアントId。
  • OAuthJWTCertPassword:JWT 証明書に関連付けられたパスワード。証明書タイプにパスワードが必要な場合は、これを設定します。

SharePointOAuth

AuthScheme をSharePointOAuth に設定します。SharePointOAuth への接続には、次の接続プロパティを使用します。

  • Schema:REST。
  • InitiateOAuth:GETANDREFRESH。
  • OAuthClientId:アプリケーションのId / クライアントId。
  • OAuthClientSecret:アプリケーションのクライアントシークレット。

接続文字列の例:

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 アプリケーションの作成 を参照してください。

CData Cloud

Kerberos の使用

Kerberos

Kerberos でMicrosoft SharePoint への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます(チケットはリフレッシュされます)。

Cloud は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:

  1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
  2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。(例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。)資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
  3. チケットを取得するには:
    1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
    2. Get Ticket をクリックします。
    3. プリンシパル名とパスワードを入力します。
    4. OK をクリックします。

    チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Cloud はキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。

Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Cloud は指定されたキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、Microsoft SharePoint での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

CData Cloud

データアクセスのファインチューニング

Microsoft SharePoint 接続の調整

高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。

  • UseDisplayNames:これをtrue に設定すると、基底のAPI のフィールド名と合致する列名を返します。
    デフォルトでは、Cloud はSharePoint で定義されたフィールド名と合致する列名を使います。
  • UseSimpleNames:これをtrue に設定すると、SharePoint が許容するが他のデータベースでは通常許容されない特殊文字を含む列名の代替を行います。
  • ShowPredefinedColumns:これをfalse に設定するとリスト内のフィールドから派生しているフィールドを除外します。例えば、Author とCreatedAt です。
    この設定は、SELECT * 構文およびスキーマ検出で、事前に定義されたフィールドが返されないようにします。
  • ShowHiddenColumns:これをtrue に設定すると、SharePoint で非表示に設定されている列がCloud で表示されます。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Microsoft SharePoint Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

  • SSLClientCert:クライアント証明書のための証明書ストア名。
  • SSLClientCertType:TLS / SSL クライアント証明書を格納するキーストアの種類。
  • SSLClientCertPassword:TLS / SSL クライアント証明書のパスワード。
  • SSLClientCertSubject:TLS / SSL クライアント証明書のサブジェクト。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

SOAP データモデル

CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

データモデルのカスタマイズ

Cloud は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。

  • CalculatedDataType:計算フィールドで使用されるデータ型。
  • CreateIDColumns:他のリストに格納されている情報からの値を使っているSharePoint 列に補助的Id 列を作成するかしないかを示します。
  • FolderOption:結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
  • PseudoColumns:疑似列をテーブルメタデータの列としてレポートするかどうかを示します。

テーブル

テーブル では、利用可能なテーブルを説明します。

Cloud は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。

ビュー

一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。

リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。

SELECT * FROM ListName WHERE ViewID='ID of the view'
Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。
SELECT * FROM Views WHERE List ='ListName'

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

CData Cloud

データタイプマッピング

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

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

CData Cloud

テーブル

Cloud はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Microsoft SharePoint テーブル

Name Description
Attachments 指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。
Groups SharePoint のグループを作成、更新、削除、およびクエリします。
Roles SharePoint のロールを作成、更新、削除、およびクエリします。
Users SharePoint のユーザーを更新、削除、およびクエリします。
Views SharePoint 内にあるリストを作成、更新、削除、およびクエリします。

CData Cloud

Attachments

指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。

Table Specific Information

Select

List and ItemId are required to return Attachments.

Insert

Call the AddAttachments stored procedure to add new attachments to a list item.

Columns

Name Type ReadOnly Description
Url [KEY] String True

用語セットの説明。

List String True

添付ファイルの取得元になるリストの内部名。

ListDisplayName String True

添付ファイルの取得元になるリストの表示名。

ItemID String True

添付ファイルの取得元になるリスト内の項目のId。

Name String True

項目の添付ファイルの名前。

CData Cloud

Groups

SharePoint のグループを作成、更新、削除、およびクエリします。

テーブル固有の情報

Insert

このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。

UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。

Columns

Name Type ReadOnly Description
Name# [KEY] String False

グループの名前。

Description# String False

グループの説明。

OwnerLogin# String False

グループのオーナーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。

OwnerType# String False

オーナーのタイプ。ユーザーまたはグループ。

DefaultLogin# String False

グループのデフォルトユーザーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UserName String

グループを取得する対象になるユーザーの論理名。指定したユーザーのグループだけを返すには、SELECTステートメントでこの値を指定します。

CData Cloud

Roles

SharePoint のロールを作成、更新、削除、およびクエリします。

Table Specific Information

Select

To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.

Insert

To insert a Role, at a minimum the Name is required:

INSERT INTO Roles (Name) VALUES ('My Role')

Columns

Name Type ReadOnly Description
Name# [KEY] String False

ロールの名前。

Description# String False

ロールの説明。

Permissions# String False

ロールの権限を表すlong。

RoleType String True

ロールのタイプ。

IsHidden Boolean True

ロールが非表示かどうかを示すboolean。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UserName String

ロールを取得する対象になるユーザーのログイン名。指定したユーザーに割り当てられたロールだけを返すには、SELECTステートメントでこの値を指定します。

GroupName String

ロールを取得する対象になるグループ名。指定したグループに割り当てられたロールだけを返すには、SELECT ステートメントでこの値を指定します。

CData Cloud

Users

SharePoint のユーザーを更新、削除、およびクエリします。

Table Specific Information

Select

Retrieves all users created for the SharePoint Account:

SELECT * FROM Users

You can retrieve Users that belong to a specific Group. In this case specify the Group Name:

SELECT * FROM Users WHERE [Group] = "GroupName"

Or you can retrieve Users that have a specific Role. In this case specify the Role Name:

SELECT * FROM Users WHERE [Role] = "RoleName"

Columns

Name Type ReadOnly Description
ID String True

ユーザーのId。

LoginName# [KEY] String False

ユーザーのログイン名。

Name# String False

ユーザーの名前。

Email# String False

ユーザーのE メールアドレス。

IsInDomainGroup Boolean True

ユーザーがドメイングループに属するかどうかを示すboolean。

IsSiteAdmin Boolean True

ユーザーがサイト管理者であるかどうかを示すboolean。

Notes# String False

ユーザーに関するオプションのメモ。

SecurityId String True

ユーザーのセキュリティId(SID)。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Group String

ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。

Role String

ユーザーを追加、および選択/削除する先のロール。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。

CData Cloud

Views

SharePoint 内にあるリストを作成、更新、削除、およびクエリします。

Table Specific Information

Views is a special table. It may be used to get, update, insert, and delete views from a specified List.

Select

To return results from Views, yout must specify either the ID or List in the SELECT statement. For example,


SELECT * FROM Views WHERE List = 'MyListName'

Insert

The List, Name, and Fields columns are required to insert to this table.

Columns

Name Type ReadOnly Description
ID [KEY] String True

ビューのId。

List String True

ビューを関連付けるリスト。SELECTステートメントの実行時にIdを指定しない場合は、リストを指定する必要があります。

ViewID String True

ビューのId。特定のリストに対して一意であれば十分です。

Name String False

ビューの名前。

Type String False

ビューのタイプ。挿入および更新では、この値を指定する必要があります。

使用できる値は次のとおりです。CALENDAR, GRID, HTML

デフォルト値はHTMLです。

Fields String False

ビューに関連付けられたフィールドのカンマ区切りリスト。これは、スペースを文字と認識します。

IsDefault Boolean False

ビューがリストのデフォルトビューかどうかを示すboolean。

Query String False

ビューのクエリ。

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Microsoft SharePoint ビュー

Name Description
FileVersions SharePoint内のファイルのバージョンをリストします。
GetValidTerms 指定されたテーブルの指定された列に対して有効な用語のリストを取得します。
Lists SharePoint 内にあるリストをリストします。
Permissions サイト、もしくはリストへの許可。 Note:ItemId が空の場合は、ObjectType をList またはweb に設定します(ObjectType がlist の場合はObjectName を指定する必要があります)。そうでない場合は、ItemID とともにObjectName を指定する必要があります。
Subsites 使用可能なサブサイトをリストします。

CData Cloud

FileVersions

SharePoint内のファイルのバージョンをリストします。

ビュー固有の情報

このビューから結果を返すには、Library およびFile を指定する必要があります。

Columns

Name Type Description
ID [KEY] String バージョンのId。
Comments String 特定のバージョンに関するコメント。
CreateBy String このバージョンのファイルを変更したSharePointユーザーのユーザー名。
Date Datetime ファイルの変更日。
Size String このバージョンのファイルのサイズ。
Url String このバージョンのファイルのURL。
Library String リストするバージョンがあるSharePoint内のライブラリ名。ファイルのバージョンを取得するには、ライブラリを指定する必要があります。

デフォルト値はShared Documentsです。

File String バージョンをリストするSharePoint内のファイルの名前。ファイルのバージョンを取得するには、ファイルを指定する必要があります。

CData Cloud

GetValidTerms

指定されたテーブルの指定された列に対して有効な用語のリストを取得します。

Columns

Name Type Description
ID [KEY] String 用語の識別子。
TermLabelValue String 用語のラベル。
Description String 用語セットの説明。
NameInRequestedLang String クライアントから要求された言語による用語セットの名前。
IsOpen Boolean 用語セットが開いているかどうかを示すBoolean。
Deprecated Boolean 用語が廃止されているかどうかを示すBoolean。
InternalId String 用語の内部識別子。
TermSetContact String 用語セットの連絡先。
ContainerDesc String 説明のコンテナーノード。
SingleTermLabelDesc String これは、1つの用語ラベルを完全に記述します。
IsDefaultLabel Boolean 用語ラベルがデフォルトの用語ラベルの場合はtrue。
BelongsTo String この項目は、用語が所属する用語セットを記述します。
IsTaggingAvailable Boolean 用語セットをタグ付けに使用できる場合、この値はtrueです。
TermPath String 用語ラベルを含む用語の用語パス。
TermpathoftermwithIds String 識別子を含む用語の用語パス。
ChildTerms String PertainingToTermで指定された用語の子用語のカスタムソート順を示す文字列値。
HasChildTerms Boolean 用語に子用語が含まれる場合はtrue。
PertainingToTerm String この用語セット情報の関連先の用語の識別子。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
List String 有効な用語の取得元になるリストの名前。
ColumnName String 有効な用語の取得元になる列の名前。
LocaleId String 用語のロケールId。デフォルトは1033です。

CData Cloud

Lists

SharePoint 内にあるリストをリストします。

View Specific Information

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

Name Type Description
ID [KEY] String リストのId。
Title String リストのタイトル。この列は、WHERE句内で使用したり、ワイルドカード(*)文字と組み合わせて使用することができます。
Description String リストの説明。
BaseTemplate String リストの作成に使用されるテンプレートのタイプを示す。この列は、WHERE句内で使用できます。
Version Double リストのバージョン。
Url String リストのデフォルトURL。
EmailAlias String リストのE メールエイリアス。
ImageUrl String リストの画像URL。
ItemCount Integer リスト内の項目の数。
Item_Deleted Datetime このリスト内の項目が最後に削除された時刻。
Item_Modified Datetime このリスト内の項目が最後に変更された時刻。
SendToUrl String リストの送信先URL。
Created Datetime リストの作成時刻。
AllowDeletion String 項目を削除できるかどうか。
AllowMultiResponses Boolean アンケートに対して複数の回答が可能かどうかを示すBoolean。
Direction String 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。
EnableAssignedToEmail Boolean 割り当てE メールが有効かどうかを示すBoolean。案件リストにのみ適用されます。
EnableAttachments Boolean リスト内の項目に添付ファイルを追加できるかどうかを示すBoolean。ドキュメントライブラリには適用されません。
EnableModeration Boolean リストにコンテンツの承認が有効かどうかを示すBoolean。
EnableVersioning Boolean リストにバージョン管理が有効かどうかを示すBoolean。
Hidden Boolean リストが非表示かどうかを示すBoolean。非表示のリストは、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページにルックアップフィールドのオプションとして表示されません。
MultipleDataList Boolean 会議ワークスペースサイトに、サイト内で複数の会議インスタンスに対応するデータが含まれているかどうかを示すBoolean。
Ordered Boolean [ビューの編集]ページでリスト内の項目をソートできるかどうかを示すBoolean。
Showuser Boolean アンケートの結果にユーザーの名前が表示されるかどうかを示すBoolean。

CData Cloud

Permissions

サイト、もしくはリストへの許可。 Note:ItemId が空の場合は、ObjectType をList またはweb に設定します(ObjectType がlist の場合はObjectName を指定する必要があります)。そうでない場合は、ItemID とともにObjectName を指定する必要があります。

Columns

Name Type Description
MemberID [KEY] String 許可のId。
Mask Long Microsoft.SharePoint.SPRights 値を表し、許可を定義する0x00000000 形式の32-bit 整数。許可を合成するカスタム許可マスクを作成する場合には、C# では'|' を、Microsoft Visual Basic では'Or' を使って区切ります。
MemberIsUser Bool ユーザーの許可かどうかを示します。
MemberGlobal Bool グループの許可かどうかを示します。
RoleName String サイトグループ名、クロスサイトグループ名、もしくは許可が適用されるユーザーのユーザー名(DOMAIN\User_Alias)を含む文字列。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ObjectName String リスト名もしくはサイトの名前が含まれる文字列。
ObjectType String リスト、もしくはウェブを指定する文字列。
ItemID String アイテムのId。

CData Cloud

Subsites

使用可能なサブサイトをリストします。

Columns

Name Type Description
Title String サブサイトの名前。
Url String サブサイトのURL。

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。

CData Cloud - Microsoft SharePoint ストアドプロシージャ

Name Description
AddAttachment SharePoint リスト項目に添付ファイルを追加します。
AddList SharePoint サイト上にリストを作成します。
AddListColumn 指定されたリストに新しいカラムを追加します。
AddUserToGroup ユーザーを指定したグループに追加します。
AddUserToRole ユーザーを指定したロールに追加します。
CheckInDocument SharePoint にドキュメントをチェックインし、ドキュメントのロックを解除します。
CheckOutDocument SharePoint からドキュメントをチェックアウトします。
CopyDocument SharePoint ライブラリからドキュメントをコピーします。
CreateFolder SharePoint サイトのドキュメントライブラリにフォルダを追加します。
DeleteAttachment SharePoint リスト項目から添付ファイルを削除します。
DeleteDocument SharePoint ライブラリからドキュメントを削除します。
DeleteList SharePoint サイトからリストを完全に削除します。
DeleteListColumn 指定されたリストからカラムを削除します。
DeleteUserFromGroup ユーザーを指定したグループから削除します。
DeleteUserFromRole ユーザーを指定したロールから削除します。
DiscardCheckOutDocument SharePoint 内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。
MoveAttachmentOrDocument ソースフォルダから宛先フォルダへドキュメントまたは添付ファイルを移動します。
RenameAttachmentOrDocument ドキュメントまたは添付ファイルの名前を変更します。
UpdateList SharePoint サイト上のリストを更新します。
UpdateListColumn 指定されたSharePoint リストのカラムを更新します。

CData Cloud

AddAttachment

SharePoint リスト項目に添付ファイルを追加します。

Input

Name Type Required Description
File String False 追加されるローカルファイルのパス。
List String True SharePoint サーバー上のリストの名前。
ItemID String True 添付ファイルの追加先になるリスト内の項目のId。
FileName String False アップロードするファイル名。コンテンツがNull でない場合に使用します。例:test.csv

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
URL String 新しく作成された項目のURL。

CData Cloud

AddList

SharePoint サイト上にリストを作成します。

Input

Name Type Required Description
Name String True SharePoint サーバー上のリストの名前。
Template String True リスト作成のためのテンプレート名。

使用できる値は次のとおりです。GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks

デフォルト値はGenericListです。

Description String False 追加するリストの説明。
Columns String False 追加するカラムの定義。json/xml/tempTable をサポート。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

AddListColumn

指定されたリストに新しいカラムを追加します。

Input

Name Type Required Description
List String True SharePoint サーバー上のリストの名前。
ColumnName String True 追加するカラム名。
DisplayName String False 追加するカラムの表示名。
DefaultValue String False 追加するカラムのデフォルト値。
ColumnType String True 追加するカラムのデータ型。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。許可される値は、Integer、Text、Note、DateTime、Counter、Choice、Lookup、Boolean、Number、Currency、URL、Computed、Threading、Guid、MultiChoice、GridChoice、Calculated、File、Attachments、User、Recurrence、CrossProjectLink、ModStat、Error、ContentTypeId、PageSeparator、ThreadIndex、WorkflowStatus、AllDayEvent、WorkflowEventType、Geolocation、OutcomeChoice です。

デフォルト値はTextです。

MaxLength String False カラムの最大長。
PrimaryKey Boolean False カラムが主キーかどうかを示すBoolean。
ReadOnly Boolean False カラムが読み取り専用かどうかを示すBoolean。
Required Boolean False カラムが必須かどうかを示すBoolean。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示すBoolean 値。

CData Cloud

AddUserToGroup

ユーザーを指定したグループに追加します。

Input

Name Type Required Description
LoginName String True ユーザーのログイン名。
Group String True ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

AddUserToRole

ユーザーを指定したロールに追加します。

Input

Name Type Required Description
LoginName String True ロールを割り当てたいユーザーのログイン名を含むカンマ区切りの値。例:'Domain\user1,Domain\user2'
Role String True ユーザーに割り当てるロール。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

CheckInDocument

SharePoint にドキュメントをチェックインし、ドキュメントのロックを解除します。

Input

Name Type Required Description
File String False SharePoint 内のドキュメントを上書きするために使用するファイルのパス。例:C:/myfolder/myfile.txt
Library String True SharePoint サーバー上のライブラリの名前。例えば、「共有ドキュメント」です。
Comment String False ファイルをチェックインするときに残すコメント。
RemoteFile String True サーバー上のファイルのパス。これには、完全URL または単純にファイル名を指定することができます。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

CheckOutDocument

SharePoint からドキュメントをチェックアウトします。

Input

Name Type Required Description
Library String True SharePoint サーバー上のライブラリの名前。
RemoteFile String True サーバー上のファイルのパス。これには、完全URL または単純にファイル名を指定することができます。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

CopyDocument

SharePoint ライブラリからドキュメントをコピーします。

実行

NewDocumentName パラメータが指定されていない場合、DocumentName で指定された値が同期先のパスとして使用されます。NewDocumentLibrary パラメータが指定されていない場合、DocumentLibrary で指定された値が新しいライブラリとして使用されます。いずれにせよ、これら2つのパラメータのうち少なくとも1つは指定する必要があります(両方同時に指定しないことはできません)。一方で、DocumentLibrary およびDocumentName パラメータは常に必須です。以下のクエリ例を参照してください:

EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentName = 'Destination Document.txt';
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Document.txt', NewDocumentLibrary = 'Destination Library';
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'Destination Document.txt';
NewDocumentName パラメータがフォルダ(末尾が '/')の場合、DocumentName のドキュメント名が新しいファイル名として代わりに使用されます。以下のクエリ例を参照してください:
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'Destination Folder/Subfolder/';

さらに、完全なURL を指定すると、SharePoint インスタンスの別のサイトにドキュメントをコピーできます。このシナリオでは、NewDocumentLibrary が必須です。以下のクエリ例を参照してください:

EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = '/Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'https://mysite.sharepoint.com/sites/Destination%20Site/Destination%20Library/Destination%20Folder/Subfolder/Destination%20Document.txt';

Input

Name Type Required Description
DocumentName String True コピー元のドキュメントの、そのライブラリに対する相対位置。
DocumentLibrary String True コピー元のドキュメントが保存されているライブラリの表示名。
NewDocumentLibrary String False コピーされたドキュメントの保存先ライブラリの表示名。空欄のままにすると、新しい名前はDocumentLibrary と同じになります。
NewDocumentName String False コピーされたドキュメントの、新しいライブラリに対する相対位置。空欄のままにすると、新しい名前はDocumentName と同じになります。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
Id String ドキュメントのId。
DocumentId String ドキュメントId。
DocumentIdUrl String ドキュメントId のURL。
FileRef String ドキュメントのファイル参照。

CData Cloud

CreateFolder

SharePoint サイトのドキュメントライブラリにフォルダを追加します。

Input

Name Type Required Description
Library String True SharePoint サーバー上のライブラリの名前。
Name String True ドキュメントの追加先のフォルダの名前。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DeleteAttachment

SharePoint リスト項目から添付ファイルを削除します。

Input

Name Type Required Description
URL String True 削除される添付ファイルの完全URL。
List String False SharePoint サーバー上のリストの名前。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DeleteDocument

SharePoint ライブラリからドキュメントを削除します。

Input

Name Type Required Description
Library String True SharePoint サーバー上のライブラリの名前。
Path String True ドキュメントライブラリから削除するファイル(またはフォルダ)のパス。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DeleteList

SharePoint サイトからリストを完全に削除します。

Input

Name Type Required Description
List String True SharePoint サーバー上のリストの名前。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DeleteListColumn

指定されたリストからカラムを削除します。

Input

Name Type Required Description
List String True SharePoint サーバー上のリストの名前。
ColumnName String True 削除するカラム名。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示すBoolean 値。

CData Cloud

DeleteUserFromGroup

ユーザーを指定したグループから削除します。

Input

Name Type Required Description
LoginName String True ユーザーのログイン名。
Group String True ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DeleteUserFromRole

ユーザーを指定したロールから削除します。

Input

Name Type Required Description
LoginName String True ロールの割り当てを解除したいユーザーのログイン名を含むカンマ区切りの値。例:'Domain\user1,Domain\user2'
Role String True ユーザーの割り当てを解除したいロール。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

DiscardCheckOutDocument

SharePoint 内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。

Input

Name Type Required Description
Library String True SharePoint サーバー上のライブラリの名前。
RemoteFile String True サーバー上のファイルのパス。これは完全なURL でも単にファイル名でもかまいません。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

MoveAttachmentOrDocument

ソースフォルダから宛先フォルダへドキュメントまたは添付ファイルを移動します。

Input

Name Type Required Description
List String True ドキュメントまたは添付ファイルを移動するリストの名前。
SourceFileURL String True ソースファイルのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。

例:
Root Directory ファイル: /Shared Documents/filename.txt
Sub-directory ファイル:/Shared Documents/MyFolder/filename.txt
サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。
Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。
DestinationFolderURL String True ファイルを移動したい宛先フォルダのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。

例:
Root Directory: /Shared Documents/
Sub-directory:/Shared Documents/MyFolder/
>サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。
Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

RenameAttachmentOrDocument

ドキュメントまたは添付ファイルの名前を変更します。

Input

Name Type Required Description
List String True 名前を変更したいドキュメントまたは添付ファイルを含むリストの名前。
SourceFileURL String True 名前を変更したいファイルのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。

例:
Root Directory ファイル: /Shared Documents/filename.txt
Sub-directory ファイル:/Shared Documents/MyFolder/filename.txt
サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。
Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。
NewFileName String True 拡張子付きの新しいファイル名。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

UpdateList

SharePoint サイト上のリストを更新します。

Input

Name Type Required Description
List String True リストの名前またはGUID。
AllowMultiResponses String False アンケートに複数回答を許可するには、True に設定します。
Description String False リストの説明を含む文字列。
Direction String False 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。

使用できる値は次のとおりです。LTR, RTL, None

EnableAssignedToEmail String False True に設定すると、issue リストの指定受信メールが有効になります。
EnableAttachments String False True に設定すると、リスト内のアイテムに添付できるようになります。ドキュメントライブラリには適用されません。
EnableModeration String False True に設定すると、リストのContent Approval が有効になります。
EnableVersioning String False True に設定すると、リストのバージョン管理が有効になります。
Hidden String False True に設定すると、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページに、ルックアップフィールドのオプションとしてリストが表示されなくなります。
MultipleDataList String False True に設定すると、会議ワークスペースサイトのリストに、サイト内の複数の会議インスタンスのデータが含まれるようにします。
Ordered String False True に設定すると、ユーザーがリスト内のアイテムを並べ替えることができるオプションをリストの[ビューの編集]ページで使用できるようになります。
ShowUser String False True に設定すると、アンケートの結果にユーザーの名前が表示されるようになります。
Title String False リストのタイトルを含む文字列。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

UpdateListColumn

指定されたSharePoint リストのカラムを更新します。

Input

Name Type Required Description
List String True カラムが含まれるリストのGUID または名前。
ColumnName String True 更新するカラム名。
DisplayName String False カラムの表示名の新しい値。
DefaultValue String False カラムのデフォルト値の新しい値。
ColumnType String False カラムの型の新しい値。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。許可される値は、Integer、Text、Note、DateTime、Counter、Choice、Lookup、Boolean、Number、Currency、URL、Computed、Threading、Guid、MultiChoice、GridChoice、Calculated、File、Attachments、User、Recurrence、CrossProjectLink、ModStat、Error、ContentTypeId、PageSeparator、ThreadIndex、WorkflowStatus、AllDayEvent、WorkflowEventType、Geolocation、OutcomeChoice です。
MaxLength String False カラムの最大長の新しい値。
PrimaryKey Boolean False カラムが主キーかどうかを示すBoolean。.
ReadOnly Boolean False カラムが読み取り専用かどうかを示すBoolean。これは新規または編集フォームでカラムを非表示にします。
Required Boolean False このカラムが新規または編集フォームで必須であるかどうかを示すBoolean 値。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示すBoolean 値。

CData Cloud

REST データモデル

CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

テーブル

Microsoft SharePoint サイトのリストは、リレーショナルテーブルとして動的に生成されます。そのため、新しいリストやフィールドを加えるなどの変更をリスト内で行うと、ドライバーにも反映されます。

テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。

ビュー

ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

OData 標準の使用

REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。

NOTE: "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に $select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。

CData Cloud

データタイプマッピング

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

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

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Microsoft SharePoint ビュー

Name Description
Attachments Reads attachments to the specified item to the specified list.
Comments This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.
Files Reads attachments to the specified item to the specified list.
Groups Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.
Lists Query the available lists on your sharepoint site.
ListItems This view represents general SharePoint items containing standard columns across various SharePoint lists.
RoleAssignmentMember Get Web RoleAssignments member.
RoleAssignments Acquires Web RoleAssignments.
RoleDefinitionBindings Get Web Role definition binding.
Roles Contains details about role definitions available in the SharePoint site collection.
Subsites This lists the available subsites.
Users Represents users and their roles in the SharePoint site or group.

CData Cloud

Attachments

Reads attachments to the specified item to the specified list.

Table Specific Information

Select

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

Columns

Name Type References Description
Id [KEY] String The Id of the attachment to 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

Lists.Title

The internal name of the list to retrieve attachments from.
ItemID Int The Id of the item in the list to retrieve attachments from.

CData Cloud

Comments

This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.

Columns

Name Type References Description
Id [KEY] Int A unique identifier for each comment.
ItemId [KEY] Int

ListItems.Id

The ID of the item associated with the comment.
List String

Lists.Title

The name of the SharePoint list containing the item and its comments.
ListId String The unique ID of the list the comment belongs to.
AuthorId Int The unique identifier of the comment's author.
AuthorEmail String The email address of the comment's author.
IsReply Bool Indicates whether the comment is a reply to another comment.
ParentId Int

Comments.Id

The unique ID of the parent comment if this is a reply.
ReplyCount Int The total number of replies to the comment.
LikeCount Int The total number of likes on the comment.
IsLikedByUser Bool Indicates whether the comment is liked by the current user.
Text String The text content of the comment.
Mentions String A list of users mentioned in the comment, if any.
CreatedDate Datetime The date and time when the comment was originally created.
ModifiedDate Datetime The date and time when the comment was last modified.

CData Cloud

Files

Reads attachments to the specified item to the specified list.

Columns

Name Type References Description
Id [KEY] String Unique identifier
CreatedBy_Id String The ID of the user that added the file
CreatedBy_Name String The name of the user that added the file
CreatedBy_Puid String The personal ID of the user that added the file
ETag String ETag value
LastModifiedBy_Id String The ID of the user that last modified the file
LastModifiedBy_Name String The name of the user that last modified the file
LastModifiedBy_Puid String The personal ID of the user that last modified the file
Name String Name of the file including the extension
Size Long The size of the file in bytes, excluding the size of any Web Parts that are used in the file.
TimeCreated Datetime Specifies when the file was created.
TimeLastModified Datetime Specifies when the file was last modified.
Url String URL of the file
List String The display name of the list to retrieve files from.

CData Cloud

Groups

Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.

Columns

Name Type References Description
Id [KEY] Int The unique identifier for the group.
LoginName String The login name or alias associated with the group.
Title String The display name of the group or principal.
AllowMembersEditMembership Bool Indicates whether group members are allowed to modify the membership of the group.
AllowRequestToJoinLeave Bool Indicates whether users can request to join or leave the group.
AutoAcceptRequestToJoinLeave Bool Indicates whether requests to join or leave the group are automatically accepted.
CanCurrentUserEditMembership Bool Indicates whether the current user has permissions to edit the group's membership.
CanCurrentUserManageGroup Bool Indicates whether the current user has permissions to manage the group.
CanCurrentUserViewMembership Bool Indicates whether the current user can view the group's membership details.
Description String A brief description or summary of the group's purpose or function.
IsHiddenInUI Bool Indicates whether the group is hidden from the user interface.
OnlyAllowMembersViewMembership Bool Indicates whether only members of the group are allowed to view its membership details.
OwnerTitle String The display name of the group's owner.
RequestToJoinLeaveEmailSetting String The email address where membership requests (to join or leave) are sent.
PrincipalType Int Specifies the type of principal. This is a bitwise value where possible. Types include: None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All = 15.

CData Cloud

Lists

Query the available lists on your sharepoint site.

Table Specific Information

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

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

CData Cloud

ListItems

This view represents general SharePoint items containing standard columns across various SharePoint lists.

Columns

Name Type References Description
ID [KEY] Int Unique identifier for the list item.
Title String Title of the list item.
Attachments Bool Indicates if the item has attachments.
Description String Detailed description of the item.
List [KEY] String

Lists.Title

The display name of the list to retrieve items from.
ContentTypeID String Identifier for the content type of the item.
FileSystemObjectType Int Indicates the type of object in the file system, such as: '-1': Invalid, '0': File, '1': Folder, '2': Web.
GUID String Globally unique identifier for the item.
Version String The version string of the item indicates its version history.
CreatedBy Int

Users.Id

Identifier for the author of the item.
ModifiedBy Int

Users.Id

Identifier for the last editor of the item.
Created Datetime Date and time when the item was created.
Modified Datetime Date and time when the item was last modified.

CData Cloud

RoleAssignmentMember

Get Web RoleAssignments member.

Table Specific Information

Select

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 = 'MyTestList' AND ItemId = '3'

Columns

Name Type References Description
ID [KEY] Int 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.
PrincipalType Int The principal type of the role assigned member. None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All principal types = 15.
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.
List String

Lists.Title

The display name of the list to retrieve role assigned member from.
ItemId Int List item id for role assignment.
PrincipalId Int

RoleAssignments.PrincipalId

The Principal Id.

CData Cloud

RoleAssignments

Acquires Web RoleAssignments.

Table Specific Information

Select


SELECT * FROM RoleAssignments WHERE List = 'TestApp'
SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'MyListName' AND ItemId = '3'

Columns

Name Type References Description
ID [KEY] String The Id of the role assigned.
PrincipalId Int The Principal ID for role assigned.
Updated Datetime The updated date for role assigned.
List String

Lists.Title

The display name of the list to retrieve role assigned from.
ItemId Int List item id for role assignments.

CData Cloud

RoleDefinitionBindings

Get Web Role definition binding.

Table Specific Information

Select

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'

Columns

Name Type References Description
PrincipalId [KEY] Int

RoleAssignments.PrincipalId

The Principal Id.
ID [KEY] Int The ID of the role assigned member.
BasePermissions_High Long The base permissions high.
BasePermissions_Low Long 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.
List String

Lists.Title

The display name of the list to retrieve role assigned member from.
ItemId Int List item id for role defintion.

CData Cloud

Roles

Contains details about role definitions available in the SharePoint site collection.

Columns

Name Type References Description
Id [KEY] Int Specifies the unique identifier of the role definition.
BasePermissions_High Long Specifies the high-level base permissions set for the role definition.
BasePermissions_Low Long Specifies the low-level base permissions set for the role definition.
Description String Provides a description of the role definition's purpose and permissions.
Hidden Bool Indicates whether the role definition is hidden from the Permission Levels page.
Name String Defines the name assigned to the role definition.
Order Int Specifies the display order of the role definition on the Permission Levels page in the site collection.
RoleTypeKind Int Represents the type of role definition, mapping to an SP.RoleType enumeration.

CData Cloud

Subsites

This lists the available subsites.

Columns

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.
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.
AccessRequestListUrl String The AccessRequestListUrl of the subsite.
AccessRequestSiteDescription String The AccessRequestSiteDescription of the subsite.
Acronym String The Acronym of the subsite.
AllowAutomaticASPXPageIndexing Boolean The AllowAutomaticASPXPageIndexing of the subsite.
AllowCreateDeclarativeWorkflowForCurrentUser Boolean The AllowCreateDeclarativeWorkflowForCurrentUser of the subsite.
AllowDesignerForCurrentUser Boolean The AllowDesignerForCurrentUser of the subsite.
AllowMasterPageEditingForCurrentUser Boolean The AllowMasterPageEditingForCurrentUser of the subsite.
AllowRevertFromTemplateForCurrentUser Boolean The AllowRevertFromTemplateForCurrentUser of the subsite.
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Boolean The AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser of the subsite.
AllowSavePublishDeclarativeWorkflowForCurrentUser Boolean The AllowSavePublishDeclarativeWorkflowForCurrentUser of the subsite.
CommentsOnSitePagesDisabled Boolean The CommentsOnSitePagesDisabled of the subsite.
ContainsConfidentialInfo Boolean The ContainsConfidentialInfo of the subsite.
CustomSiteActionsDisabled Boolean The CustomSiteActionsDisabled of the subsite.
DefaultNewPageTemplateId String The DefaultNewPageTemplateId of the subsite.
DescriptionForExistingLanguage String The DescriptionForExistingLanguage of the subsite.
DescriptionTranslations String The DescriptionTranslations of the subsite.
DesignerDownloadUrlForCurrentUser String The DesignerDownloadUrlForCurrentUser of the subsite.
DisableAppViews Boolean The DisableAppViews of the subsite.
DisableFlows Boolean The DisableFlows of the subsite.
DisableRecommendedItems Boolean The DisableRecommendedItems of the subsite.
EffectiveBasePermissions_High Long The EffectiveBasePermissions_High of the subsite.
EffectiveBasePermissions_Low Long The EffectiveBasePermissions_Low of the subsite.
ExcludeFromOfflineClient Boolean The ExcludeFromOfflineClient of the subsite.
HasWebTemplateExtension Boolean The HasWebTemplateExtension of the subsite.
IsEduClass Boolean The IsEduClass of the subsite.
IsEduClassProvisionChecked Boolean The IsEduClassProvisionChecked of the subsite.
IsEduClassProvisionPending Boolean The IsEduClassProvisionPending of the subsite.
IsProvisioningComplete Boolean The IsProvisioningComplete of the subsite.
LastItemModifiedDate Datetime The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate Datetime The LastItemUserModifiedDate of the subsite.
LogoAlignment Int The LogoAlignment of the subsite.
NotificationsInOneDriveForBusinessEnabled Boolean The NotificationsInOneDriveForBusinessEnabled of the subsite.
NotificationsInSharePointEnabled Boolean The NotificationsInSharePointEnabled of the subsite.
PrimaryColor String The PrimaryColor of the subsite.
RelatedHubSiteIds String The RelatedHubSiteIds of the subsite.
RequestAccessEmail String The RequestAccessEmail of the subsite.
SaveSiteAsTemplateEnabled Boolean The SaveSiteAsTemplateEnabled of the subsite.
SearchBoxInNavBar Int The SearchBoxInNavBar of the subsite.
SearchBoxPlaceholderText String The SearchBoxPlaceholderText of the subsite.
ServerRelativePath_DecodedUrl String The ServerRelativePath_DecodedUrl of the subsite.
ShowUrlStructureForCurrentUser Boolean The ShowUrlStructureForCurrentUser of the subsite.
SiteLogoDescription String The SiteLogoDescription of the subsite.
SupportedUILanguageIds String The SupportedUILanguageIds of the subsite.
TenantTagPolicyEnabled Bit The TenantTagPolicyEnabled of the subsite.
ThemeData String The ThemeData of the subsite.
ThemedCssFolderUrl String The ThemedCssFolderUrl of the subsite.
ThirdPartyMdmEnabled Boolean The ThirdPartyMdmEnabled of the subsite.
TitleForExistingLanguage String The TitleForExistingLanguage of the subsite.
TitleTranslations String The TitleTranslations of the subsite.
WebTemplateConfiguration String The WebTemplateConfiguration of the subsite.
WebTemplatesGalleryFirstRunEnabled Boolean The WebTemplatesGalleryFirstRunEnabled of the subsite.
WebTemplatesGalleryFirstRunComplete Boolean The WebTemplatesGalleryFirstRunComplete of the subsite.

CData Cloud

Users

Represents users and their roles in the SharePoint site or group.

Table Specific Information

Select


SELECT * FROM Users // Fetch all the Users
SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group

Columns

Name Type References Description
Id [KEY] Int Unique identifier for each user in the SharePoint environment.
LoginName String The unique login name used by the user to access the SharePoint environment.
Title String The display name or title associated with the user.
IsHiddenInUI Bool Indicates whether the user is hidden from the SharePoint user interface.
GroupId Int The identifier of the group to which the user belongs.
AadObjectId_NameId String Azure Active Directory (AAD) object ID representing the user's unique identifier.
AadObjectId_NameIdIssuer String The issuer of the Azure Active Directory (AAD) NameId for the user.
Email String Primary email address associated with the user.
EmailWithFallback String An alternate or fallback email address for the user if the primary is unavailable.
Expiration String Specifies the expiration date of the user's access, if applicable.
HexCid String A hexadecimal representation of the user's client ID.
IsEmailAuthenticationGuestUser Bool Indicates if the user is a guest authenticated via email.
IsShareByEmailGuestUser Bool Indicates if the user is a guest invited via email for sharing purposes.
IsSiteAdmin Bool Specifies whether the user has administrative rights for the site collection.
UserId_NameId String The unique identifier for the user in SharePoint's user ID system.
UserId_NameIdIssuer String The issuer of the user's ID in SharePoint's user ID system.
UserPrincipalName String User Principal Name (UPN) for the user, usually an email-style identifier.
PrincipalType Int Defines the type of principal, using bitwise values: None=0, User=1, DistributionList=2, SecurityGroup=4, SharePointGroup=8, All=15.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。

CData Cloud - Microsoft SharePoint ストアドプロシージャ

Name Description
AddAttachment SharePoint リストに添付ファイルを追加します。
AddImage Sharepoint のリスト項目に画像を追加します。
AddList SharePoint サイト上にリストを作成します。
AddListColumn 指定されたリストに新しいカラムを追加します。
AddRoleAssignment Adds a new role assignment with the specified principal and role definitions to the list, or list item.
BreakRoleInheritance Breaks the security inheritance of a list, or list item so that role assignments on the parent object no longer apply to the child object.
CheckInDocument 特定のドキュメントをドキュメントライブラリにチェックインします。
CheckOutDocument ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。
CopyDocument Copies the file to the destination URL..
CreateFolder SharePoint サイトのドキュメントライブラリにフォルダを追加します。
DeleteAttachment Deletes an attachment from Sharepoint list.
DeleteDocument Deletes a Document from the SharePoint document library.
DeleteList SharePoint サイトからリストを完全に削除します。
DeleteListColumn 指定されたリストからカラムを削除します。
DiscardCheckOutDocument Reverts an existing checkout for the file.
GetAdminConsentURL アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。
GetCurrentUser 現在ログインしているユーザーの情報を取得します。
MoveAttachmentOrDocument Moves a document or attachment from a source folder to a destination folder.
RemoveRoleAssignment Removes the role assignment with the specified principal and role definition from the list, or list item.
RenameAttachmentOrDocument Renames a document or attachment.

CData Cloud

AddAttachment

SharePoint リストに添付ファイルを追加します。

Input

Name Type Required Description
ListTitle String True リストアイテムのタイトル。
ItemId String True リストアイテムのId。
FileName String True ドキュメントライブラリに追加するファイル名。
InputFilePath String False ファイルを添付する場所。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
RelativeUrl String 追加された添付ファイルの相対URL。

CData Cloud

AddImage

Sharepoint のリスト項目に画像を追加します。

Input

Name Type Required Description
ListName String True SharePoint 上のリストの表示名。
ItemId String True リストアイテムのId。
ColumnInternalName String True 追加するカラム名。
FileName String True 画像として追加するファイル名。
InputFilePath String False ファイルを添付する場所。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
ErrorCode Integer このプロシージャが正常に実行されなかった場合、この出力には、失敗した実行に関連するエラーコードが表示されます。
ErrorMessage String このプロシージャが正常に実行されなかった場合、この出力には、失敗した実行に関連するエラーメッセージが表示されます。

CData Cloud

AddList

SharePoint サイト上にリストを作成します。

Input

Name Type Required Description
Name String True SharePoint サーバー上のリストの名前。
Template String False リスト作成のためのテンプレート名またはId。
Description String False 追加するリストの説明。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
ErrorCode Integer プロシージャが正常に実行されなかった場合のエラーコード。
ErrorMessage String プロシージャが正常に実行されなかった場合のエラーメッセージ。

CData Cloud

AddListColumn

指定されたリストに新しいカラムを追加します。

Input

Name Type Required Description
ListName String True SharePoint 上のリストの表示名。
ColumnDisplayName String True 追加するカラムの表示名。
ColumnType String True 追加するカラムのデータ型。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://docs.microsoft.com/ja-jp/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。
ColumnInternalName String False 追加するカラム名。
IsRequired Boolean False カラムが必須かどうかを示すBoolean。
EnforceUniqueValues Boolean False カラムに一意な値を指定するかどうかを示すBoolean。
DisplayAfterCreation Boolean False 追加されたフィールドをSharePoint UI に表示するかどうかを示すBoolean。デフォルト値はtrue です。
LookupListId String False ルックアップしたいフィールドの場所のリストId。
LookupFieldName String False ルックアップしたいフィールドの表示名。

Result Set Columns

Name Type Description
Success Boolean 操作が正常に実行されたかどうかを示します。
ErrorCode Integer プロシージャが正常に実行されなかった場合のエラーコード。
ErrorMessage String プロシージャが正常に実行されなかった場合のエラーメッセージ。

CData Cloud

AddRoleAssignment

Adds a new role assignment with the specified principal and role definitions to the list, or list item.

Input

Name Type Required Description
RoleId Int True The ID of the role definition that defines the permissions to assign.
PrincipalId Int True The ID of the user or group to assign permissions to.
List String True The internal name of the list to add the role assignment.
ItemId Int False The list item id to add the role assignment.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.
ErrorCode Integer The error code in case the procedure is not executed successfully.
ErrorMessage String The error message in case the procedure is not executed successfully.

CData Cloud

BreakRoleInheritance

Breaks the security inheritance of a list, or list item so that role assignments on the parent object no longer apply to the child object.

Input

Name Type Required Description
List String True The internal name of the list to break the security inheritance.
ItemId Int False The list item id to break the security inheritance.
CopyRoleAssignments Boolean False Specifies whether to copy the role assignments from the parent object.

デフォルト値はtrueです。

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.
ErrorCode Integer The error code in case the procedure is not executed successfully.
ErrorMessage String The error message in case the procedure is not executed successfully.

CData Cloud

CheckInDocument

特定のドキュメントをドキュメントライブラリにチェックインします。

Input

Name Type Required Description
RelativeURL String True フォルダの相対URL。
DocumentName String True チェックインするファイル名。
Comment String False ドキュメントをチェックインする際の任意のメッセージ。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

CheckOutDocument

ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。

Input

Name Type Required Description
RelativeURL String True フォルダの相対URL。
DocumentName String True チェックインするファイル名。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。

CData Cloud

CopyDocument

Copies the file to the destination URL..

Input

Name Type Required Description
SourceFileRelativeUrl String True The relative URL of the source file.
DestFileRelativeUrl String True The relative URL of the destination file.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.

CData Cloud

CreateFolder

SharePoint サイトのドキュメントライブラリにフォルダを追加します。

Input

Name Type Required Description
RelativeURL String True フォルダの相対URL。
FolderName String True 作成するフォルダ名。
SiteURL String False このフォルダを作成するサイトのベースURL('URL' 接続プロパティのものと同じSharePoint インスタンス内 / 同じドメイン内)。このパラメータが使用される場合、この値は'URL' 接続プロパティの値よりも優先されます。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
Id String 操作の完了後に返される一意の識別子の値。

CData Cloud

DeleteAttachment

Deletes an attachment from Sharepoint list.

Input

Name Type Required Description
ListTitle String True The Title of the list item.
ItemId String True The Id of the list item.
FileName String True The name of the file to be added to the document library

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.

CData Cloud

DeleteDocument

Deletes a Document from the SharePoint document library.

Input

Name Type Required Description
RelativePath String True The path of the document you want to delete, relative to the value specified in the URL connection property. For example: '/Shared Documents/My Folder/My Document.txt'.
Permanently String False If True, deletes the document permanently. Otherwise, the Cloud moves the document to the recycle bin.

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful.
ErrorCode Integer When this procedure is not executed successfully, this output displays the error code associated with the failed execution.
ErrorMessage String When this procedure is not executed successfully, this output displays the error message associated with the failed execution.

CData Cloud

DeleteList

SharePoint サイトからリストを完全に削除します。

Input

Name Type Required Description
Name String True SharePoint サーバー上のリストの名前。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
ErrorCode Integer プロシージャが正常に実行されなかった場合のエラーコード。
ErrorMessage String プロシージャが正常に実行されなかった場合のエラーメッセージ。

CData Cloud

DeleteListColumn

指定されたリストからカラムを削除します。

Input

Name Type Required Description
ListName String True SharePoint 上のリストの表示。
ColumnName String True 削除するカラムの表示名。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。
ErrorCode Integer プロシージャが正常に実行されなかった場合のエラーコード。
ErrorMessage String プロシージャが正常に実行されなかった場合のエラーメッセージ。

CData Cloud

DiscardCheckOutDocument

Reverts an existing checkout for the file.

Input

Name Type Required Description
RelativeURL String True The relative URL of the folder.
DocumentName String True The name of the file to be checked in.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.

CData Cloud

GetAdminConsentURL

アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。

Input

Name Type Required Description
CallbackUrl String False アプリケーションが認可された後にユーザーがリダイレクトされるURL。この値は、Azure AD アプリ設定内のリダイレクトURL に合致する必要があります。
State String False 認証コードをリクエストしたときに送信した状態と同じ値。
Scope String False 管理者にリクエストしているスコープまたは権限。

デフォルト値はAllSites.Manageです。

Result Set Columns

Name Type Description
URL String ベリファイアトークンを取得してアプリを認可するためにWeb ブラウザに入力される、認可URL。

CData Cloud

GetCurrentUser

現在ログインしているユーザーの情報を取得します。

Result Set Columns

Name Type Description
Id Int ユーザーId。
Title String ユーザーの役職。
Email String ユーザーの電子メール。
IsSiteAdmin Boolean ユーザーがサイト管理者かどうか。

CData Cloud

MoveAttachmentOrDocument

Moves a document or attachment from a source folder to a destination folder.

Execute

The paths specified in SourceFileURL and DestinationFolderURL must be relative to what you have used in Url. Refer to the query example below:

/* URL = https://mysite.sharepoint.com/sites/Subsite */
EXEC MoveAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', DestinationFolderURL = '/Destination Library/Destination Folder/';

Input

Name Type Required Description
SourceFileURL String True The path of the source file, relative to the base Url supplied in the Cloud's connection properties.
DestinationFolderURL String True The path of the destination folder where you want to move the file, relative to the base Url supplied in the Cloud's connection properties.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.

CData Cloud

RemoveRoleAssignment

Removes the role assignment with the specified principal and role definition from the list, or list item.

Input

Name Type Required Description
RoleId Int True The ID of the role definition in the role assignment.
PrincipalId Int True The ID of the user or group in the role assignment
List String True The internal name of the list to remove the role assignment.
ItemId Int False The list item id to remove the role assignment.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.
ErrorCode Integer The error code in case the procedure is not executed successfully.
ErrorMessage String The error message in case the procedure is not executed successfully.

CData Cloud

RenameAttachmentOrDocument

Renames a document or attachment.

Execute

The path specified in SourceFileURL must be relative to what you have used in Url. Refer to the query example below:

/* URL = https://mysite.sharepoint.com/sites/Subsite */
EXEC RenameAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', NewFileName = 'Renamed Document.txt';

Input

Name Type Required Description
SourceFileURL String True The path of the file you want to rename, relative to the base Url supplied in the Cloud's connection properties.
NewFileName String True The new name of the file, with a file extension.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeSharePoint への認証に使用されるスキーム。
URLサイトのベースURL。
SharePointEdition使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User認証で使用されるSharePoint ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft SharePoint テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続を確立するときに使用するAzure 環境。

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainシングルサインオン(SSO)を使用する場合のユーザーのドメイン。
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
ScopeThe scope used for the OAuth flow to access data from the Application.
State追加のOAuth ステート情報を表すオプションの値。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuerJava Web Token の発行者。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Schema使用するスキーマの種類。

Miscellaneous


プロパティ説明
CalculatedDataType計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。
ContinueOnErrorエラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。
DisableFilterLimitMicrosoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。
GetColumnsMetadataSpecifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumnsこのオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。
IncludeLookupDisplayValueColumnsDetermines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PagesizeMicrosoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ShowHiddenColumns非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViewsメタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。
STSURLシングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesAPI 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeNameBoolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeSharePoint への認証に使用されるスキーム。
URLサイトのベースURL。
SharePointEdition使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User認証で使用されるSharePoint ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
CData Cloud

AuthScheme

SharePoint への認証に使用されるスキーム。

Possible Values

AzureAD, AzureServicePrincipalCert, AzurePassword, PingFederate, ADFS, OneLogin, Okta, OAuthJWT, Negotiate, None

データ型

string

デフォルト値

"AzureAD"

解説

SharePoint オンプレミスインスタンスに対して認証を行う場合、Password およびUser とともにこのフィールドはサーバーに対する認証に使用されます。デフォルトのオプションはNTLM です。次のオプションを使って、認証スキームを選択してください。

  • NTLM:認証にWindows クレデンシャルを使う場合に設定。
  • Negotiate:AuthScheme がNegotiate に設定された場合、Cloud は認証メカニズムをサーバーとネゴシエートします。Kerberos 認証を使いたい場合はAuthScheme をNegotiate に設定します。
  • None:匿名認証を使用する場合に設定。例えばパブリックサイトにアクセスする場合です。
  • Basic:HTTP Basic 認証を使う場合に設定。
  • ADFS:ADFS でシングルサインオン認証を使う場合に設定。

SharePoint Online に認証する場合、AzureAD がデフォルトのオプションです。次のオプションを使って、認証スキームを選択してください。

  • AzureAD:Azure Active Directory OAuth 認証を実行する場合に設定。
  • AzureServicePrincipalCert:証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。
  • AzurePassword:Password GrantType でOAuth 認証を使う場合に設定。
  • PingFederate:PingFederate でシングルサインオン認証を使う場合に設定。
  • ADFS:ADFS でシングルサインオン認証を使う場合に設定。
  • OneLogin:OneLogin でシングルサインオン認証を使う場合に設定。
  • OKTA:OKTA でシングルサインオン認証を使う場合に設定。
  • AzureMSI:Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得するために設定。
  • SharePointOAuth:Sharepoint アプリクライアントクレデンシャルによるOAuth 認証を使う場合に設定。

CData Cloud

URL

サイトのベースURL。

データ型

string

デフォルト値

""

解説

以下は有効なURL の例です。

  • http://server/SharePoint/
  • http://server/Sites/mysite/
  • http://server:90/
プロバイダーは、URL を使用して、他のサーバー呼び出しのためのURL を派生します。

CData Cloud

SharePointEdition

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

Possible Values

SharePoint Online

データ型

string

デフォルト値

"SharePoint Online"

解説

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

CData Cloud

User

認証で使用されるSharePoint ユーザーアカウント。

データ型

string

デフォルト値

""

解説

このフィールドは、Password とともに、SharePoint サーバーに対して認証をするために使われます。

SharePoint On-Premise では、User にドメインを含める必要があり、User は"DOMAIN\Username" のようになります。

SharePoint Onlineでは、User は"[email protected]" のようになります。

CData Cloud

Password

ユーザーの認証で使用されるパスワード。

データ型

string

デフォルト値

""

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

CData Cloud

Azure Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft SharePoint テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続を確立するときに使用するAzure 環境。
CData Cloud

AzureTenant

データにアクセスするために使用されるMicrosoft SharePoint テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)

データ型

string

デフォルト値

""

解説

テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

CData Cloud

AzureEnvironment

接続を確立するときに使用するAzure 環境。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、Azure アカウントを別の環境に追加している場合は、AzureEnvironment を使用してどの環境かを指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、およびUSGOVTDOD です。

このプロパティを使って、使用しているクラウドに基づいてURL サフィックスの問題を解決します(例えば、URL が.us で終わる場合はUSGOVT に設定)。設定についての詳細は、こちらからご覧いただけます: 「各国のクラウド」についてのMicrosoft ドキュメント。

CData Cloud

SSO

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainシングルサインオン(SSO)を使用する場合のユーザーのドメイン。
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
CData Cloud

SSOLoginURL

ID プロバイダーのログインURL。

データ型

string

デフォルト値

""

解説

ID プロバイダーのログインURL。

CData Cloud

SSODomain

シングルサインオン(SSO)を使用する場合のユーザーのドメイン。

データ型

string

デフォルト値

""

解説

このプロパティは、シングルサインオンを使用する場合(UseSSO がSSO 認証スキームを使用するように設定されている場合)でUser のドメイン(例:[email protected])がSSO サービスで設定されたドメイン(例:[email protected])と異なる場合のみ適用可能です。

このプロパティは、ADFS、OneLogin またはOKTA SSO サービス使用時に必要になる場合があります。

CData Cloud

SSOProperties

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

データ型

string

デフォルト値

""

解説

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
ScopeThe scope used for the OAuth flow to access data from the Application.
State追加のOAuth ステート情報を表すオプションの値。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

Scope

The scope used for the OAuth flow to access data from the Application.

Possible Values

NONE, AllSites.Manage, AllSites.Read, AllSites.Write, .default

データ型

string

デフォルト値

"NONE"

解説

The scope used for the OAuth flow to access data from the Application.

Note: If not specified or left to 'NONE', the Cloud sets the default scope dependant upon OAuthGrantType. Defaults to 'AllSites.Manage' unless using JWT OAuth, Azure Service Principal, or CLIENT grant type. The available values are:

  • AllSites.Read: Enables reading custom lists
  • AllSites.Write: Enables reading & writing custom lists
  • AllSites.Manage: Enables reading, writing and creating custom lists
  • .default: Requests application permissions without a user context. All the application permissions that have been granted for that web API are included in the retrieved OAuthAccessToken.

CData Cloud

State

追加のOAuth ステート情報を表すオプションの値。

データ型

string

デフォルト値

""

解説

追加のOAuth ステート情報を表すオプションの値。

CData Cloud

OAuthGrantType

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

Possible Values

CODE, PASSWORD, SAML_1, CLIENT

データ型

string

デフォルト値

"CODE"

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

CData Cloud

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuerJava Web Token の発行者。
CData Cloud

OAuthJWTCert

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

CData Cloud

OAuthJWTCertType

JWT 証明書を格納するキーストアの種類。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の一つを設定できます。

USERWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。

CData Cloud

OAuthJWTCertPassword

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

CData Cloud

OAuthJWTIssuer

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 ほとんどの場合、これはOAuth App Id(クライアントId)接続プロパティの値を使用するため、個別に設定する必要はありません。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Schema使用するスキーマの種類。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Schema

使用するスキーマの種類。

Possible Values

REST

データ型

string

デフォルト値

"REST"

解説

利用可能なスキーマは、REST(Sharepoint のREST API を使う場合)およびSOAP(Sharepoint のSOAP API を使う場合)です。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
CalculatedDataType計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。
ContinueOnErrorエラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。
DisableFilterLimitMicrosoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。
GetColumnsMetadataSpecifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumnsこのオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。
IncludeLookupDisplayValueColumnsDetermines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PagesizeMicrosoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ShowHiddenColumns非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViewsメタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。
STSURLシングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesAPI 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeNameBoolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
CData Cloud

CalculatedDataType

計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。

Possible Values

Calculated, Boolean, Date, DateTime, Double, Integer, String

データ型

string

デフォルト値

"Calculated"

解説

デフォルト(Calculated)では、SharePoint の計算フィールドの型によってデータ型が判定されます。ただし、これらの計算フィールドが、指定された型に合わない値を返す場合があります。このような場合は、CalculatedDataType を適切な型に設定できます。

CData Cloud

ContinueOnError

エラー後にバッチ内の項目の更新を続行するかどうかを示します。

データ型

bool

デフォルト値

true

解説

このプロパティをTrue(デフォルト)に設定すると、項目の1つでエラーが発生した場合も、Cloud は引き続き項目の追加、更新、削除を行います。False に設定すると、エラーが発生した後、Cloud は項目の追加、更新、削除を停止します(問題があるエントリの前にあるエントリは、引き続き追加、更新、削除されます)。

このプロパティはSOAP とREST スキーマの両方に適用されます。

CData Cloud

CreateIDColumns

他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。

データ型

bool

デフォルト値

true

解説

true の場合、Cloud は他のリストに格納されている情報からの値を使っている("Lookup" または"Person or Group" 列のように)SharePoint 列に補助的ID 列を作成します。作成されたID 列は関連するエントリーのID をオリジナルリストのコンテキストの中で保有します。

false に設定されている場合にはID は作成されず、ID は無視されID は参照列の値のみが返されます。

CData Cloud

DisableFilterLimit

Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.

データ型

bool

デフォルト値

false

解説

Regardless of whether this property is set to true or false, for list filters with 5000 or fewer records, server-side processing of list filter queries is supported by Microsoft SharePoint, leading to the fastest possible performance.

When this property is set to true and the list filter exceeds 5000 entries, the Cloud will delegate the filters to the server, and they will be processed server-side. Note that trying to pull more than 5000 entries this way will likely result in a server error.

However, if this property is set to false (the default behavior) and the list filter exceeds 5000 entries, the Cloud will query from the list itself (as opposed to the list filter) and the filtering will be done client-side, which has an extra cost to performance.

CData Cloud

FolderOption

結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。

Possible Values

FilesOnly, FilesAndFolders, RecursiveAll

データ型

string

デフォルト値

"RecursiveAll"

解説

  • FilesOnly は、指定されたリストまたはライブラリ内のファイルだけを表示します。
  • FilesAndFolders は、指定されたリスト内のファイルとフォルダを表示します。
  • RecursiveAll は、指定されたリストとすべてのサブフォルダ内のファイルを表示します。

CData Cloud

GetColumnsMetadata

Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.

Possible Values

OnUse, OnStart

データ型

string

デフォルト値

"OnUse"

解説

Available settings:

  • OnStart: The Cloud retrieves and caches metadata for all columns in every table before executing the first statement.
  • OnUse: The Cloud retrieves table-specific metadata the first time the table is referenced, if the metadata is not already cached.

CData Cloud

IncludeLookupColumns

このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。

データ型

bool

デフォルト値

true

解説

SharePoint サーバーは、1つのクエリに多数のルックアップ列が含まれている場合、リクエストを拒否します。

CData Cloud

IncludeLookupDisplayValueColumns

Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.

データ型

bool

デフォルト値

false

解説

For the REST schema, the driver will by default push the record identifiers from which a list lookup column retrieves the data from. For example:

MultiLookUpColumn=1, 2

When this property is enabled (true), an additional column (name is suffixed with _DisplayValue) for each lookup column will be listed during metadata retrieval, from which the actual data of the looked-up column can be queried. For example:

MultiLookUpColumn=1, 2
MultiLookUpColumn_DisplayValue=United States, United Kingdom

Note that enabling this connection property will likely result in worse performance, because the server will need more time and resources to retrieve the values of the look up columns.

CData Cloud

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

Pagesize

Microsoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

1000

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

CData Cloud

ShowHiddenColumns

非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。

データ型

bool

デフォルト値

false

解説

このプロパティはSOAP とREST スキーマの両方に適用されます。

CData Cloud

ShowPredefinedColumns

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。

データ型

bool

デフォルト値

true

解説

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 通常、これはCreatedBy やAuthor などのシステム列です。ただし、定義済みの列にはTitle などの一般的な列が含まれることもあります。

このプロパティはSOAP とREST スキーマの両方に適用されます。

CData Cloud

ShowVersionViews

メタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。

データ型

bool

デフォルト値

false

解説

リストバージョンをビューとして含めるかどうかを示します(例:ListA_Versions)。

CData Cloud

STSURL

シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。

データ型

string

デフォルト値

""

解説

シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。これを明示的に設定する必要はめったにありません。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseDisplayNames

API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。

データ型

bool

デフォルト値

true

解説

このプロパティはSOAP とREST スキーマの両方に適用されます。

CData Cloud

UseEntityTypeName

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.

データ型

bool

デフォルト値

false

解説

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field.

CData Cloud

UseNTLMV1

ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。

データ型

bool

デフォルト値

false

解説

ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。

CData Cloud

UseSimpleNames

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

データ型

bool

デフォルト値

false

解説

Microsoft SharePoint テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175