Cloud

Build 25.0.9434
  • 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
        • UpdateGroup
        • UpdateList
        • UpdateListColumn
        • UpdateRole
    • REST データモデル
      • データタイプマッピング
      • OData 規格の使用
      • ビュー
        • AllEvents
        • AllFiles
        • AllLists
        • AllPages
        • Attachments
        • Comments
        • Files
        • Groups
        • Lists
        • ListItems
        • RoleAssignmentMember
        • RoleAssignments
        • RoleDefinitionBindings
        • Roles
        • Sites
        • Subsites
        • Users
      • ストアドプロシージャ
        • AddAttachment
        • AddImage
        • AddList
        • AddListColumn
        • AddPage
        • AddRoleAssignment
        • AddUserToGroup
        • BreakRoleInheritance
        • CheckInDocument
        • CheckOutDocument
        • CheckPermissions
        • CopyDocument
        • CopyFolderJob
        • CreateFolder
        • DeleteAttachment
        • DeleteDocument
        • DeleteList
        • DeleteListColumn
        • DiscardCheckOutDocument
        • GetAdminConsentURL
        • GetCurrentUser
        • GetJobStatus
        • MoveAttachmentOrDocument
        • MoveFolderJob
        • RemoveRoleAssignment
        • RemoveUserFromGroup
        • RenameAttachmentOrDocument
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • URL
        • SharePointEdition
        • User
        • Password
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • SSO
        • SSOLoginURL
        • SSODomain
        • SSOProperties
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
        • State
      • 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
        • ResolveCalculatedTypes
        • ShowHiddenColumns
        • ShowPredefinedColumns
        • ShowVersionViews
        • STSURL
        • Timeout
        • UseDisplayNames
        • UseEntityTypeName
        • UseNTLMV1
        • UseSimpleNames
    • Third Party Copyrights

Microsoft SharePoint - CData Cloud

概要

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

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、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 にアクセスする場合はオプション)の作成については、カスタムEntra ID(Azure AD)アプリケーションの作成 を参照してください。

Microsoft SharePoint Online

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

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

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

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

Microsoft Entra ID(Azure AD)

Note:Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

Microsoft Entra ID(AzureAD)は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft SharePoint との通信を要求します。下記で説明するとおり、本ドライバーはいくつかの方法でこれをサポートします。

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

シングルサインオン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:JWT アサーションの発行者。
  • OAuthJWTCertPassword:JWT 証明書に関連付けられたパスワード。証明書タイプにパスワードが必要な場合は、これを設定します。

SharePointOAuth

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

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

接続文字列の例:

SharePointEdition='SharePointOnline';URL=https://contoso.sharepoint.com;Schema=REST;AuthScheme=SharePointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;
この認証方式(AuthScheme)は、SharePoint のアプリ専用プリンシパルと連携して動作します。アプリ専用プリンシパルの構成およびアクセス許可の付与方法については、カスタムEntra ID(Azure AD)アプリケーションの作成 を参照してください。この認証方式に該当するのは、SharePoint アプリセクションのみです。

2026年4月2日をもって、Microsoft 365 のSharePoint におけるAzure Access Control Services(ACS)は廃止されます。この日以降、既存のユーザーはAzure ACS プリンシパルを作成したり、SharePoint にアクセスするために使用したりすることができなくなります。また、2024年11月1日以降、新しいテナントではAzure ACS の利用ができなくなっています。この変更は、米国政府機関向けクラウド(Government Clouds)および米国国防総省(Department of Defense)を含むすべての環境に適用されます。

Microsoft は、より安全な認証方式であるAzureAD またはOAuthJWT への移行を推奨しています。

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 設定のカスタマイズ

TLS を有効化するには、以下を設定します。

  • URL:接続文字列の前にhttps:// を付加します。

この設定により、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 データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。これらのオブジェクトへのライブ接続により、Microsoft SharePoint アカウントへのあらゆる変更はCloud に即座に反映されます。

テーブル

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

一般的なテーブルには以下のものが含まれます。

テーブル 説明
Attachments SharePoint リストアイテムの添付ファイルを管理し、取得および削除を可能にします。SharePoint 内で頻繁にファイル添付を扱うユーザーにとって不可欠です。
Groups SharePoint セキュリティグループの作成、変更、削除、および取得を可能にします。ユーザーの権限管理とアクセス制御に不可欠です。
Roles SharePoint のロールとアクセス許可の割り当ての作成、変更、削除、および取得を許可します。アクセス制御のカスタマイズに役立ちます。
Users SharePoint ユーザーを管理し、ユーザーの詳細の更新、削除、および取得を可能にします。SharePoint ユーザー管理を最新の状態に保つために重要です。
Views 階層の詳細を含め、SharePoint サイト内のすべてのサブサイトをリストします。サイトのナビゲーションと組織化に役立ちます。

ビュー

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

一般的なビューには以下のものが含まれます。

テーブル 説明
FileVersions SharePoint に保存されているドキュメントのすべての利用可能なバージョンをリストします。バージョン履歴の詳細を含みます。変更を追跡し、以前のドキュメントバージョンを復元するのに便利です。
GetValidTerms SharePoint リスト内の特定の列に関連付けられた有効な管理メタデータ用語のリストを取得します。SharePoint コンテンツの一貫した分類とタグ付けを実施するのに役立ちます。
Lists プロパティや設定を含む、サイト上で利用可能なすべてのSharePoint リストのメタデータを取得します。SharePoint リストの構造や使用状況を理解するのに役立ちます。
Permissions サイト、もしくはリストへのアクセス許可。Note:ItemId が空の場合は、ObjectType をList またはWeb に設定します(ObjectType がList の場合はObjectName を指定する必要があります)。そうでない場合は、ItemID とともにObjectName を指定する必要があります。
Subsites SharePoint のロールとアクセス許可の割り当ての作成、変更、削除、および取得を許可します。アクセス制御のカスタマイズに役立ちます。

また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。

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

ストアドプロシージャ

ストアドプロシージャ は、SQL クエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、ユーザー、ドキュメント、添付ファイルの管理など、より高度なタスクも実行します。

CData Cloud

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

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

  • ResolveCalculatedTypes:SharePoint の計算列が、その数式の結果型に対応するSQL データ型を割り当てられるかどうかを制御します。このプロパティを有効にすると、計算式の結果型(数値、通貨、日時、はい / いいえなど)を読み取り、その結果型を最も近いネイティブSQL 型にマッピングすることで、各計算列のデータ型を自動的に決定します。無効にすると、すべての計算列は文字列として扱われます。
  • CreateIDColumns:他のリストに格納されている情報からの値を使っているSharePoint 列に補助的Id 列を作成するかしないかを示します。
  • FolderOption:結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
  • PseudoColumns:疑似列をテーブルメタデータの列としてレポートするかどうかを示します。

CData Cloud

データタイプマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Microsoft SharePoint CData スキーマ
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 SharePoint リストアイテムの添付ファイルを管理し、取得と削除を可能にします。SharePoint 内でファイルの添付ファイルを頻繁に扱うユーザーに不可欠です。
Groups SharePoint セキュリティグループの作成、削除、取得が可能です。ユーザー権限とアクセス制御の管理に不可欠です。
Roles SharePoint ロールの作成、削除、取得が可能です。アクセス制御のカスタマイズに役立ちます。
Users SharePoint ユーザーを管理し、ユーザー詳細の更新、削除、取得を可能にします。SharePoint ユーザー管理を最新状態に保つために重要です。
Views SharePoint リストのビューを取得、作成、更新、または削除し、表示データのカスタマイズを可能にします。特定のビジネスニーズに合わせてリストビューを調整するのに便利です。

CData Cloud

Attachments

SharePoint リストアイテムの添付ファイルを管理し、取得と削除を可能にします。SharePoint 内でファイルの添付ファイルを頻繁に扱うユーザーに不可欠です。

テーブル固有の情報

Select

Attachments を返すにはList とItemId が必要です。

サンプルクエリ

次のクエリは、MyAttachmentList という名前のリストから、ItemId = 4 のアイテムの添付ファイルを取得します。

SELECT * FROM Attachments WHERE List = 'MyAttachmentList' AND ItemId = 4;

Insert

リストアイテムに新しい添付ファイルを追加するには、AddAttachment ストアドプロシージャを呼び出します。

Columns

Name Type ReadOnly Description
Url [KEY] String True

添付ファイルへのURL パス。添付ファイルへのアクセスまたはダウンロードに役立ちます。

List String True

添付ファイルを含むSharePoint リストの内部名。添付ファイルのソースリストの識別に役立ちます。

ListDisplayName String True

添付ファイルを含むSharePoint リストの表示名。リストのユーザーフレンドリーな識別に役立ちます。

ItemID String True

添付ファイルがリンクされているリスト内のアイテムの一意識別子。関連ファイルの追跡に役立ちます。

Name String True

添付ファイルの名前。ファイル名の表示と添付ファイルの管理に役立ちます。

CData Cloud

Groups

SharePoint セキュリティグループの作成、削除、取得が可能です。ユーザー権限とアクセス制御の管理に不可欠です。

テーブル固有の情報

SELECT

SharePoint Account で作成されたすべてのグループを取得する:
SELECT * FROM Groups

SharePoint Account で指定した名前を持つすべてのグループを取得する:

SELECT * FROM Groups WHERE [Name] = 'Group1'
SELECT * FROM Groups WHERE [Name] IN ('Group1', 'Group2')

特定のユーザーが所属するグループを取得する:

SELECT * FROM Groups WHERE [UserLoginName] = "LoginName"

特定のロールが割り当てられているグループを取得する:

SELECT * FROM Groups WHERE [RoleName] = "RoleName"

INSERT

以下のクエリ例に示すようにINSERT ステートメントで書き込み可能(ReadOnly=false)な列を指定することでグループを作成できます。一部の列は常に必須ですが、その他の列はオプションで指定できることに注意してください。
INSERT INTO Groups(Name, Description, DefaultUserLoginName, OwnerName, OwnerType) VALUES('Testing Group 5', 'Testing Group 5.', 'RIDDLERSP2013\\administrator', 'Testing Group 4', 'group')

DELETE

以下のクエリ例のように、条件としてName 列を指定することで、グループを削除できます。
DELETE FROM Groups WHERE Name = 'Group1'

Columns

Name Type ReadOnly Description
Name [KEY] String False

グループの名前。SharePoint 内でグループを識別するのに役立ちます。

Id String True

グループの一意識別子。

Description String False

グループの簡潔な説明。その目的とメンバーシップを理解するのに役立ちます。

OwnerId String True

グループ所有者の一意識別子。

OwnerType String False

所有者がユーザーか別のグループかを指定します。グループ管理階層の定義に役立ちます。

使用できる値は次のとおりです。user, group

UserLoginName String True

特定のユーザーが所属するグループを読み取るためのフィルター。この列が条件で指定されない場合、null 値になります。

RoleName String True

特定のロールが割り当てられたグループを読み取るためのフィルタ。この列が条件で指定されない場合、null 値になります。

Pseudo-Columns

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

Name Type Description
OwnerName String

作成するグループの所有者となるユーザーまたはグループの名前。これは'INSERT' ステートメントでのみ使用される書き込み専用の列です。

DefaultUserLoginName String

グループの既定ユーザーのユーザー名。この値はDOMAIN\\username の形式である必要があります。これは'INSERT' ステートメントでのみ使用される書き込み専用の列です。

CData Cloud

Roles

SharePoint ロールの作成、削除、取得が可能です。アクセス制御のカスタマイズに役立ちます。

テーブル固有の情報

SELECT

SharePoint Account で作成されたすべてのロールを取得する:
SELECT * FROM Roles

SharePoint Account で指定した名前を持つすべてのロールを取得する:

SELECT * FROM Roles WHERE [Name] = 'Role1'
SELECT * FROM Roles WHERE [Name] IN ('Role1', 'Role2')

特定のグループに割り当てられたロールを取得する:

SELECT * FROM Roles WHERE [GroupName] = "GroupName"

特定のユーザーに割り当てられたロールを取得する:

SELECT * FROM Roles WHERE [UserLoginName] = "LoginName"

INSERT

以下のクエリ例に示すようにINSERT ステートメントで書き込み可能(ReadOnly=false)な列を指定することでロールを作成できます。一部の列は常に必須ですが、その他の列はオプションで指定できることに注意してください。
INSERT INTO Roles (Name, Description, Permissions) VALUES ('Testing Role 3', 'Role for testing.', '1073741826')

DELETE

以下のクエリ例のように、条件としてName 列を指定することで、ロールを削除できます。
DELETE FROM Roles WHERE Name = 'ReadOnly'

Columns

Name Type ReadOnly Description
Name [KEY] String False

ロールの名前。ユーザーやグループに割り当てられた権限レベルを識別するのに役立ちます。

Id String True

ロールの一意識別子。

Description String False

ロールの簡潔な説明。その目的と付与される権限を理解するのに役立ちます。

Permissions String False

ロールに付与されるアクセス許可のマスク。アクセス制御レベルの定義に役立ちます。アクセス許可マスクの詳細については、Permissions の「アクセス許可マスク」セクションを参照してください。

RoleType String True

ロールの種類を指定します。組み込みロールとカスタムロールを区別するのに役立ちます。

IsHidden Boolean True

ロールがユーザーインターフェースで非表示になっているかどうかを示します。システム定義または制限されたロールの管理に役立ちます。

UserLoginName String True

特定のユーザーに割り当てられたロールを読み取るためのフィルタ。この列が条件で指定されない場合、null 値になります。

GroupName String True

特定のグループに割り当てられたロールを読み取るためのフィルタ。この列が条件で指定されない場合、null 値になります。

CData Cloud

Users

SharePoint ユーザーを管理し、ユーザー詳細の更新、削除、取得を可能にします。SharePoint ユーザー管理を最新状態に保つために重要です。

テーブル固有の情報

SELECT

SharePoint Account のために作成されたすべてのユーザーを取得する:
SELECT * FROM Users

SharePoint Account で指定したログイン名を持つすべてのユーザーを取得する:

SELECT * FROM Users WHERE [LoginName] = 'DOMAIN\\User1'
SELECT * FROM Users WHERE [LoginName] IN ('DOMAIN\\User1', 'DOMAIN\\User2')

特定のグループに所属するユーザーを取得する:

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

特定のロールが割り当てられているユーザーを取得する:

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

UPDATE

以下のクエリ例のように、条件としてLoginName 列を指定することで、ユーザーデータを更新できます。
UPDATE Users SET Notes = 'User 1 notes.' WHERE LoginName = 'DOMAIN\\User1'

DELETE

以下のクエリ例のように、条件としてLoginName 列を指定することで、ユーザーを削除できます。
DELETE FROM Users WHERE LoginName = 'DOMAIN\\User1'

Columns

Name Type ReadOnly Description
LoginName [KEY] String True

ユーザーのログイン名。通常はDOMAIN\\username 形式です。SharePoint 内でユーザーの認証と識別に役立ちます。

Id String True

ユーザーに割り当てられた一意識別子。クエリや権限管理でユーザーを参照する際に役立ちます。

Name String False

ユーザーの表示名。SharePoint インターフェースでユーザーフレンドリーな名前を表示するのに役立ちます。

Email String False

ユーザーに関連付けられたプライマリメールアドレス。コミュニケーションや通知に使用されます。

IsInDomainGroup Boolean True

ユーザーがドメイングループのメンバーかどうかを示します。グループベースのアクセス制御の管理に役立ちます。

IsSiteAdmin Boolean True

ユーザーがSharePoint サイトの管理権限を持っているかどうかを示します。高レベルアクセスユーザーの識別に役立ちます。

Notes String False

ユーザーに関連するオプションの注記や追加情報。内部ドキュメント作成や追跡に役立ちます。

SecurityId String True

ユーザーに割り当てられたセキュリティ識別子(SID)。ユーザー権限の管理と追跡に役立ちます。

GroupName String False

特定のグループ内のユーザーを読み取るためのフィルタ。この列が条件で指定されない場合、null 値になります。

RoleName String False

特定のロールが割り当てられたユーザーを読み取るためのフィルタ。この列が条件で指定されない場合、null 値になります。

CData Cloud

Views

SharePoint リストのビューを取得、作成、更新、または削除し、表示データのカスタマイズを可能にします。特定のビジネスニーズに合わせてリストビューを調整するのに便利です。

テーブル固有の情報

Views は特別なテーブルです。これを使用して、指定されたリストのビューを取得、更新、挿入、および削除できます。

Select

Views から結果を返すには、SELECT ステートメントでID またはList 列のいずれかを指定する必要があります。

サンプルクエリ

List 列を使用:

SELECT * FROM Views WHERE List = 'MyListName';

ID 列を使用:

SELECT * FROM Views WHERE ID = 'list1|{24676099-47E8-4C07-BABE-47EB9BEBA2F9}';

Insert

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

Columns

Name Type ReadOnly Description
ID [KEY] String True

ビューの一意の識別子。SharePoint の特定のビューを参照および管理するために使用します。

List String True

ビューに関連付けられたリストの名前。ビューID が指定されていない場合は、SELECT 文でリストを指定する必要があります。

ViewID String True

特定のリスト内のビューの一意の識別子。リスト内の複数のビューを管理するのに便利です。

Name String False

ビューの表示名。ユーザーが簡単にビューを識別し、選択できるようにします。

Type String False

Standard、Calendar、Datasheet などのビューのタイプ。この値は挿入と更新に必要です。

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

デフォルト値はHTMLです。

Fields String False

ビューに含まれるフィールドのカンマ区切りリスト。空白に依存するため、クエリには適切な書式を使用してください。

IsDefault Boolean False

ビューがリストのデフォルトビューであるかどうかを示します。ユーザーにとって主要なビューを決定するのに役立ちます。

Query String False

ビュー内のデータをフィルタリングまたは並べ替えるために使用されるクエリ。特定の条件に基づいてリスト表示をカスタマイズするのに役立ちます。

CData Cloud

ビュー

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

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

CData Cloud - Microsoft SharePoint ビュー

Name Description
FileVersions SharePoint に保存されているドキュメントのすべての利用可能なバージョンをリストします。バージョン履歴の詳細を含みます。変更を追跡し、以前のドキュメントバージョンを復元するのに便利です。
GetValidTerms SharePoint リスト内の特定の列に関連付けられた有効な管理メタデータ用語のリストを取得します。SharePoint コンテンツの一貫した分類とタグ付けを実施するのに役立ちます。
Lists プロパティや設定を含む、サイト上で利用可能なすべてのSharePoint リストのメタデータを取得します。SharePoint リストの構造や使用状況を理解するのに役立ちます。
Permissions SharePoint サイト、リスト、またはアイテムのアクセス許可情報を取得します。
Subsites 階層の詳細を含め、SharePoint サイト内のすべてのサブサイトをリストします。サイトのナビゲーションと組織化に役立ちます。

CData Cloud

FileVersions

SharePoint に保存されているドキュメントのすべての利用可能なバージョンをリストします。バージョン履歴の詳細を含みます。変更を追跡し、以前のドキュメントバージョンを復元するのに便利です。

ビュー固有の情報

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

サンプルクエリ

次のクエリは、Documents/testd ライブラリにあるファイルMyExcelFile.xlsx のすべてのバージョンを取得します。

SELECT * FROM FileVersions WHERE Library = 'Documents/testd' AND File = 'MyExcelFile.xlsx';

Columns

Name Type Description
ID [KEY] String ファイルバージョンの一意の識別子。バージョン履歴の追跡と管理に便利です。
Comments String 特定のファイルバージョンに関するユーザー提供のコメント。変更を文書化したり、修正のコンテキストを提供したりするのに役立ちます。
CreateBy String このバージョンのファイルを変更したSharePoint ユーザーのユーザー名。作成者の追跡や責任を確認するために便利です。
Date Datetime このファイルバージョンが作成された日時。ファイルの更新や変更を時間を追って監視するのに役立ちます。
Size String この特定のファイルバージョンのサイズ。ストレージ管理やバージョン比較に便利です。
Url String この特定のファイルバージョンにアクセスするためのURL パス。ユーザーが古いバージョンを取得したりダウンロードしたりするのに役立ちます。
Library String ファイルが保存されているSharePoint ドキュメントライブラリの名前。ファイルバージョンを取得するには、ライブラリを指定する必要があります。

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

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

CData Cloud

GetValidTerms

SharePoint リスト内の特定の列に関連付けられた有効な管理メタデータ用語のリストを取得します。SharePoint コンテンツの一貫した分類とタグ付けを実施するのに役立ちます。

テーブル固有の情報

GetValidTerms は、指定されたMicrosoft SharePoint リストの分類列または管理されたメタデータ列に対して有効な用語を取得するために使用される特別なビューです。 このビューをクエリするには、List 列とColumnName 列の両方を指定する必要があります。

サンプルクエリ

次のクエリは、list1 リストのTermsC 列の有効な用語を取得します。

SELECT * FROM GetValidTerms WHERE List = 'list1' AND ColumnName = 'TermsC';

Columns

Name Type Description
ID [KEY] String 用語の一意の識別子。SharePoint でタクソノミー用語を参照および管理するのに便利です。
TermLabelValue String 用語に割り当てられたラベル。ユーザーが用語を識別しコンテンツに適用するのに役立ちます。
Description String 用語セットの簡単な説明。用語セットの目的と使用方法を理解するのに役立ちます。
NameInRequestedLang String クライアントから要求された言語による用語セットの名前。多言語対応に役立ちます。
IsOpen Boolean 新しい用語を追加するために用語セットが開いているかどうかを示します。制御された語彙を管理するのに便利です。
Deprecated Boolean 用語が廃止されているかどうかを示します。古い用語や廃止された用語の使用を防ぐのに役立ちます。
InternalId String 用語の内部識別子。システムレベルの用語管理に便利です。
TermSetContact String 用語セットの管理を担当する連絡先の人物またはグループ。ガバナンスとサポートに役立ちます。
ContainerDesc String メタデータの説明を保持するコンテナーノード。タクソノミー情報を構造化するのに役立ちます。
SingleTermLabelDesc String 1つの用語ラベルの詳細な説明。追加のコンテキストを提供するのに役立ちます。
IsDefaultLabel Boolean 用語ラベルがその用語のデフォルトであるかどうかを示します。用語の使用を標準化するのに役立ちます。
BelongsTo String この用語が属する用語セット。階層的なタクソノミーを管理するのに便利です。
IsTaggingAvailable Boolean 用語セットがタグ付けに利用可能かどうかを示します。コンテンツ分類を管理するのに役立ちます。
TermPath String 用語ラベルを含む用語の階層パス。用語の関係をナビゲートするのに便利です。
TermpathoftermwithIds String 一意の識別子を含む用語の階層パス。用語の系統を追跡するのに役立ちます。
ChildTerms String 用語階層内の子用語のカスタムソート順序。用語の整理に役立ちます。
HasChildTerms Boolean その用語に子用語があるかどうかを示します。ネストされたタクソノミー構造の管理に役立ちます。
PertainingToTerm String この用語セット情報が関連する用語の識別子。階層的な組織化に役立ちます。

Pseudo-Columns

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

Name Type Description
List String 有効な用語が取得されるSharePoint リストの名前。タクソノミーの統合に役立ちます。
ColumnName String 有効な用語が取得されるリスト内の列。メタデータの強制に役立ちます。
LocaleId String 用語のロケールID。デフォルトは1033(英語)です。多言語タクソノミーのサポートに役立ちます。

CData Cloud

Lists

プロパティや設定を含む、サイト上で利用可能なすべてのSharePoint リストのメタデータを取得します。SharePoint リストの構造や使用状況を理解するのに役立ちます。

ビュー固有の情報

Lists を使用して、SharePoint のテーブルをリストできます。これは、SharePoint 内の実際のリストだけを返します。Cloud に関連付けられた特別なテーブルは返しません。

WHERE 句で次の列を使用できます:Title およびBaseTemplage。

Columns

Name Type Description
ID [KEY] String SharePoint リストの一意の識別子。クエリやワークフローでリストを参照するのに役立ちます。
Title String リストの表示名。WHERE 句でワイルドカード(*)を使用してフィルタリングできます。
Description String リストの目的と内容の簡単な概要。ユーザーがリストの機能を理解するのに役立ちます。
BaseTemplate String リストの作成に使用されたテンプレートタイプを示します。リストタイプをフィルタリングするためにWHERE 句で使用できます。
Version Double リストの現在のバージョン番号。更新と変更を追跡するのに役立ちます。
Url String リストのデフォルトURL。ユーザーがリストに直接移動するのに役立ちます。
EmailAlias String リストに割り当てられたE メールエイリアス。E メールベースのリストのやりとりを可能にするのに役立ちます。
ImageUrl String リストに関連付けられた画像のURL。リストを視覚的に識別するのに役立ちます。
ItemCount Integer リストに現在保存されているアイテムの総数。報告と分析に役立ちます。
Item_Deleted Datetime リストから最後のアイテムが削除された日時。データの変更を追跡するのに役立ちます。
Item_Modified Datetime リスト内の最後のアイテムが変更された日時。最近のアクティビティを監視するのに役立ちます。
SendToUrl String 送信機能を使用する際にリストアイテムが送信されるURL。ドキュメントのルーティングに役立ちます。
Created Datetime リストが最初に作成された日時。リストの履歴を追跡するのに便利です。
AllowDeletion String リスト内のアイテムが削除可能かどうかを示します。データ保持ポリシーの管理に役立ちます。
AllowMultiResponses Boolean アンケートで複数の回答が許可されているかどうかを示します。フィードバック収集に役立ちます。
Direction String テキストの読み順を指定します:'LTR' は左から右、'RTL' は右から左、'None' は方向性なしを意味します。
EnableAssignedToEmail Boolean 割り当てられたユーザーに自動メール通知が送信されるかどうかを示します。問題追跡リストに適用されます。
EnableAttachments Boolean リストアイテムに添付ファイルが許可されているかどうかを示します。ドキュメントライブラリには適用されません。
EnableModeration Boolean リストに対してコンテンツの承認が有効になっているかどうかを示します。コンテンツレビューポリシーの実施に役立ちます。
EnableVersioning Boolean リストに対してバージョン管理が有効になっているかどうかを示します。リストアイテムの変更を追跡するのに役立ちます。
Hidden Boolean リストが[ドキュメントとリスト]ページ、クイック起動バー、およびその他のナビゲーションメニューで非表示かどうかを示します。
MultipleDataList Boolean 会議ワークスペースサイトがサイト内の複数の会議インスタンスのデータを含んでいるかどうかを示します。
Ordered Boolean リストアイテムが[ビューの編集]ページで手動で並べ替え可能かどうかを示します。リストの優先順位付けに便利です。
Showuser Boolean アンケート結果にユーザー名が表示されるかどうかを示します。回答者を特定するのに役立ちます。

CData Cloud

Permissions

SharePoint サイト、リスト、またはアイテムのアクセス許可情報を取得します。

ビュー固有の情報

Permissions ビューは、Microsoft SharePoint サイトまたはリストのアクセス許可情報を返します。

ItemId が指定されていない場合、ObjectType('List' または'Web')とObjectName の両方を指定する必要があります。 ItemId が指定されている場合は、ObjectName も指定する必要があります。

サンプルクエリ

ObjectType およびObjectNameを使用:

SELECT * FROM Permissions WHERE ObjectType = 'List' AND ObjectName = 'TestList' AND MemberID = '4';

ItemId およびObjectNameを使用:

SELECT * FROM Permissions WHERE ItemId = 1 AND ObjectName = 'list1';

権限マスク

SharePoint 権限マスクは、ユーザーまたはサイトグループに割り当てることができる権限を指定する8バイトの符号なし整数です。 このビットマスクには、ゼロ個以上のフラグを設定できます。プログラミング言語では、通常、ビットごとの演算子や ビットシフト演算子を使用してビットマスクからデータを抽出したり、データをビットマスクに変換したりできます。通常、これらの演算子には次の記号が予約されています:
  • &: ビットごとの論理 AND
  • |: ビットごとの論理 OR
  • ^: ビットごとの論理 XOR
  • <<: ビットごとの左シフト
  • >>: ビットごとの右シフト

SharePoint アクセス許可と権限マスクの詳細については、次のSharePoint リソースを参照してください。

  • SPBasePermissions enumeration
  • Windows SharePoint Services、PDF/DOCX 仕様ファイルのWSS Rights Mask セクションを参照してください。

Columns

Name Type Description
MemberID [KEY] String アクセス許可エントリの一意の識別子。特定のユーザーまたはグループのアクセス許可を参照および管理するために使用されます。
Mask Long Microsoft.SharePoint.SPRights 値を表す0x00000000 形式の32ビット整数。アクセス許可レベルを定義します。複数の値はC# ではパイプ記号('|')、Visual Basic では'Or' を使用して組み合わせることができます。
MemberIsUser Bool アクセス許可が個々のユーザーに適用されるかどうかを示します。ユーザーとグループのアクセス許可を区別するのに役立ちます。
MemberGlobal Bool アクセス許可がグループに適用されるかどうかを示します。ロールベースのアクセス制御を管理するのに役立ちます。
RoleName String アクセス許可が適用されるサイトグループ、クロスサイトグループ、または個々のユーザー(DOMAIN\User_Alias 形式)の名前。

Pseudo-Columns

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

Name Type Description
ObjectName String アクセス許可が適用されるSharePoint リストまたはサイトの名前。アクセス許可のスコープを特定するのに役立ちます。
ObjectType String アクセス許可が'List' または'Web' に適用されるかどうかを指定します。異なるレベルでのアクセス許可管理に役立ちます。
ItemID String アクセス許可に関連するアイテムの一意の識別子。特定のアイテムレベルのアクセス許可を追跡するのに役立ちます。

CData Cloud

Subsites

階層の詳細を含め、SharePoint サイト内のすべてのサブサイトをリストします。サイトのナビゲーションと組織化に役立ちます。

Columns

Name Type Description
Title String サブサイトの表示名。ユーザーがSharePoint 内でサブサイトを識別し、ナビゲートするのに役立ちます。
Url String サブサイトの完全なURL。SharePoint 環境内での直接アクセスやリンクに便利です。

CData Cloud

ストアドプロシージャ

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

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

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

Name Description
AddAttachment SharePoint のリストアイテムに添付ファイルを追加します。SharePoint レコードに補足ファイルをリンクする場合に便利です。
AddList 指定されたプロパティを持つ新しいSharePoint リストを作成します。構造化されたデータストレージのセットアップを自動化するのに役立ちます。
AddListColumn SharePoint リストに新しい列を追加します。リスト構造を動的に変更するのに便利です。
AddUserToGroup 指定したSharePoint グループにユーザーを追加します。ユーザーのアクセスや権限の管理に役立ちます。
AddUserToRole SharePoint の指定したロールにユーザーを割り当てます。サイト内のアクセスレベルを制御するのに便利です。
CheckInDocument ドキュメントをチェックインし、他のユーザーが変更できるようにロックを解除します。ドキュメントの更新が適切に追跡されることを確認できます。
CheckOutDocument SharePoint ライブラリからドキュメントをチェックアウトし、編集をロックします。複数のユーザーが同じファイルで作業する必要がある場合の競合を防止します。
CopyDocument ドキュメントをSharePoint 内の指定された宛先にコピーします。コンテンツの複製やアーカイブに役立ちます。
CreateFolder SharePoint ドキュメントライブラリ内に新しいフォルダを作成します。ファイルを論理的な構造で整理するのに便利です。
DeleteAttachment SharePoint リストアイテムから添付ファイルを削除します。ファイルストレージを管理し、古い添付ファイルや不要な添付ファイルを削除するのに役立ちます。
DeleteDocument SharePoint ドキュメントライブラリからドキュメントを削除します。コンテンツのライフサイクル管理や、古くなったドキュメントの確実な削除に役立ちます。
DeleteList サイトからSharePoint リストを完全に削除します。廃止されたリストを削除することで、SharePoint 環境の整理に役立ちます。
DeleteListColumn SharePoint リストから列を削除します。リスト構造を改善し、余分なフィールドを削除するのに役立ちます。
DeleteUserFromGroup 指定されたSharePoint グループからユーザーを削除します。ユーザーのロールが変更されたときにアクセスを取り消すのに便利です。
DeleteUserFromRole 指定されたSharePoint ロールからユーザーを削除します。必要に応じて権限を調整することでセキュリティを維持するのに役立ちます。
DiscardCheckOutDocument チェックアウトされたドキュメントを最後に保存された状態に戻し、保存されていない変更をキャンセルします。意図しない変更を防ぐのに役立ちます。
MoveAttachmentOrDocument SharePoint 内で添付ファイルやドキュメントをあるフォルダから別のフォルダに移動します。コンテンツを整理し、構造化されたドキュメントライブラリを維持するのに役立ちます。
RenameAttachmentOrDocument SharePoint リストやドキュメントライブラリに保存されている添付ファイルやドキュメントの名前を変更します。ファイルの内容に影響を与えずに、命名規則を標準化するのに役立ちます。
UpdateGroup SharePoint サイトコレクション内のグループを更新します。
UpdateList SharePoint リストのプロパティや設定を変更します。リストの構成を動的に調整するのに役立ちます。
UpdateListColumn SharePoint リスト内の既存の列のプロパティを更新します。構造を再作成せずに列属性を変更するのに役立ちます。
UpdateRole SharePoint サイトコレクション内のロールを更新します。

CData Cloud

AddAttachment

SharePoint のリストアイテムに添付ファイルを追加します。SharePoint レコードに補足ファイルをリンクする場合に便利です。

Input

Name Type Required Description
File String False 添付ファイルとしてアップロードするローカルファイルのフルパス。
List String True 添付ファイルが追加されるSharePoint リストの名前。
ItemID String True 添付ファイルが追加されるリストアイテムの一意の識別子。
FileName String False 添付ファイルとしてアップロードされるファイルの名前で、拡張子も含まれます(例:'document.pdf')。'Content' がnull でない場合に使用します。

Result Set Columns

Name Type Description
Success Boolean 添付ファイルが正常に追加されたかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。
URL String SharePoint で新しく作成された添付ファイルのURL。

CData Cloud

AddList

指定されたプロパティを持つ新しいSharePoint リストを作成します。構造化されたデータストレージのセットアップを自動化するのに役立ちます。

Input

Name Type Required Description
Name String True SharePoint サーバー上に作成される新しいリストの名前。
Template String True リスト作成時に使用するテンプレートの名前またはID ('Custom List' や'Document Library' など)。

使用できる値は次のとおりです。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、またはテンポラリテーブル形式を受け付けます。

Result Set Columns

Name Type Description
Success Boolean リストの作成に成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

AddListColumn

SharePoint リストに新しい列を追加します。リスト構造を動的に変更するのに便利です。

Input

Name Type Required Description
List String True 列が追加されるSharePoint リストの名前。
ColumnName String True SharePoint リスト内に作成される列の内部名。
DisplayName String False SharePoint UI に表示される列の表示名。
DefaultValue String False 値が指定されていない場合に列に割り当てられるデフォルト値。
ColumnType String True 作成する列のデータ型。有効なオプションはSharePoint API FieldTypes で定義されています。許可される値は、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 Integer False テキストベースの列タイプに適用される列値の最大長。
PrimaryKey Boolean False 列をリストの主キーとして使用するかどうかを示すBoolean 値。
ReadOnly Boolean False 列が読み取り専用で、ユーザーが変更できないかどうかを示すBoolean 値。.
Required Boolean False 各リストアイテムで列が必須かどうかを示すBoolean 値。

Result Set Columns

Name Type Description
Success Boolean 列の作成操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

AddUserToGroup

指定したSharePoint グループにユーザーを追加します。ユーザーのアクセスや権限の管理に役立ちます。

Input

Name Type Required Description
LoginName String True SharePoint グループに追加するユーザーのログイン名。これは、Active Directory ユーザーの場合は'DOMAIN\\username' 形式、Azure AD ユーザーの場合はE メールアドレスで指定する必要があります。
Group String True ユーザーを追加するSharePoint グループの名前。ユーザーを追加する際に指定する必要があります。

Result Set Columns

Name Type Description
Success Boolean ユーザーをグループに追加する操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

AddUserToRole

SharePoint の指定したロールにユーザーを割り当てます。サイト内のアクセスレベルを制御するのに便利です。

Input

Name Type Required Description
LoginName String True ロールを割り当てるユーザーのログイン名をカンマで区切ったリスト。Active Directory ユーザーの場合は'DOMAIN\\username' 形式、Azure AD ユーザーの場合はE メールアドレスを使用します。例:'Domain\\user1,Domain\\user2'
Role String True 指定したユーザーに割り当てるSharePoint ロール(アクセス許可レベル)の名前。たとえば、'Full Control'、'Edit'、'Read' などです。

Result Set Columns

Name Type Description
Success Boolean ロールの割り当て操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

CheckInDocument

ドキュメントをチェックインし、他のユーザーが変更できるようにロックを解除します。ドキュメントの更新が適切に追跡されることを確認できます。

Input

Name Type Required Description
File String False チェックイン時にSharePoint 内の既存のドキュメントを上書きするファイルのローカルパス。例:'C:/myfolder/myfile.txt'。
Library String True ファイルが存在するSharePoint サイト上のドキュメントライブラリの名前。例:'Shared Documents'。
Comment String False ドキュメントをチェックインする前に行われた変更を記述するオプションのコメント。
RemoteFile String True SharePoint ドキュメントライブラリ内のファイルの相対URL または完全URL。ファイル名のみが指定された場合、最新バージョンがチェックインされます。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのチェックイン操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

CheckOutDocument

SharePoint ライブラリからドキュメントをチェックアウトし、編集をロックします。複数のユーザーが同じファイルで作業する必要がある場合の競合を防止します。

Input

Name Type Required Description
Library String True ファイルが存在するSharePoint サイト上のドキュメントライブラリの名前。例:'Shared Documents'
RemoteFile String True チェックアウトしたいSharePoint ドキュメントライブラリ内のファイルの相対URL または完全URL。ファイル名のみが指定された場合は、デフォルトの場所からチェックアウトされます。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのチェックアウト操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

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 ドキュメントライブラリ内のコピー元のドキュメントの相対パス。例:'Folder1/OriginalFile.docx'。
DocumentLibrary String True コピー元のドキュメントが保存されているSharePoint ドキュメントライブラリの表示名。例:'Shared Documents'。
NewDocumentLibrary String False コピーされたドキュメントが保存される対象ドキュメントライブラリの表示名。空白のままにすると、ドキュメントは元のドキュメントと同じライブラリに残ります。
NewDocumentName String False 新しいライブラリ内のコピーされたドキュメントの相対パスとファイル名。空白のままにすると、ドキュメントは元の名前を保持します。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのコピー操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。
Id String コピー完了後、コピーされたドキュメントに割り当てられるの一意の識別子。
DocumentId String コピーされたファイルに割り当てられるドキュメントID。
DocumentIdUrl String コピーされたドキュメントにドキュメントID を使用してアクセスできるURL。
FileRef String コピーされたドキュメントのSharePoint ファイル参照パス。

CData Cloud

CreateFolder

SharePoint ドキュメントライブラリ内に新しいフォルダを作成します。ファイルを論理的な構造で整理するのに便利です。

Input

Name Type Required Description
Library String True 新しいフォルダが作成されるドキュメントライブラリの表示名。例:'Shared Documents'。
Name String True 指定されたドキュメントライブラリ内に作成されるフォルダの名前。例:'Project Files'。

Result Set Columns

Name Type Description
Success Boolean フォルダの作成操作が成功したかどうかを示します。成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

DeleteAttachment

SharePoint リストアイテムから添付ファイルを削除します。ファイルストレージを管理し、古い添付ファイルや不要な添付ファイルを削除するのに役立ちます。

Input

Name Type Required Description
URL String True 削除される添付ファイルの完全URL。例:'https://company.sharepoint.com/sites/documents/attachment1.jpg'。
List String False 添付ファイルが保存されているSharePoint リストの名前。例:'ProjectFiles'。

Result Set Columns

Name Type Description
Success Boolean 削除操作が成功したかどうかを示します。添付ファイルの削除に成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

DeleteDocument

SharePoint ドキュメントライブラリからドキュメントを削除します。コンテンツのライフサイクル管理や、古くなったドキュメントの確実な削除に役立ちます。

Input

Name Type Required Description
Library String True ファイルまたはフォルダが保存されているSharePoint サーバー上のドキュメントライブラリの名前。例:'Shared Documents'。
Path String True 指定されたドキュメントライブラリ内で削除されるファイルまたはフォルダの相対パス。例:'ProjectFiles/Report.pdf' または'ProjectFiles/OldFolder/'。

Result Set Columns

Name Type Description
Success Boolean 削除操作が成功したかどうかを示します。ドキュメントまたはフォルダの削除に成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

DeleteList

サイトからSharePoint リストを完全に削除します。廃止されたリストを削除することで、SharePoint 環境の整理に役立ちます。

Input

Name Type Required Description
List String True SharePoint サーバーから削除されるリストの名前。例:'ProjectTasks' や'EmployeeRecords'。

Result Set Columns

Name Type Description
Success Boolean 削除操作が成功したかどうかを示します。リストの削除に成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

DeleteListColumn

SharePoint リストから列を削除します。リスト構造を改善し、余分なフィールドを削除するのに役立ちます。

Input

Name Type Required Description
List String True 列が削除されるSharePoint リストの名前。例:'EmployeeRecords' や'ProjectTasks'。
ColumnName String True 指定されたリストから削除する列の名前。例:'StartDate' や'ProjectStatus'。

Result Set Columns

Name Type Description
Success Boolean 列の削除が成功したかどうかを示します。列が正常に削除された場合は'true' を返し、それ以外の場合は'false' を返します。

CData Cloud

DeleteUserFromGroup

指定されたSharePoint グループからユーザーを削除します。ユーザーのロールが変更されたときにアクセスを取り消すのに便利です。

Input

Name Type Required Description
LoginName String True 指定されたSharePoint グループかされるユーザーのログイン名。例:'DOMAIN\\JohnDoe' or '[email protected]'。
Group String True ユーザーを削除するSharePoint グループの名前。例:'Project Managers' や'Site Admins'。

Result Set Columns

Name Type Description
Success Boolean ユーザーがグループから正常に削除されたかどうかを示します。操作が成功した場合 'true' を返し、それ以外の場合は'false' を返します。

CData Cloud

DeleteUserFromRole

指定されたSharePoint ロールからユーザーを削除します。必要に応じて権限を調整することでセキュリティを維持するのに役立ちます。

Input

Name Type Required Description
LoginName String True 指定されたロールから削除するユーザーのログイン名のカンマ区切りリスト。例:'Domain\\user1,Domain\\user2'。
Role String True 指定されたユーザーから割り当てを解除するSharePoint ロールの名前。例:'Contributors'、'Site Owners'、または'Read-Only'。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。ユーザーが正常にロールから削除された場合は'true' を、そうでない場合は'false' を返します。

CData Cloud

DiscardCheckOutDocument

チェックアウトされたドキュメントを最後に保存された状態に戻し、保存されていない変更をキャンセルします。意図しない変更を防ぐのに役立ちます。

Input

Name Type Required Description
Library String True ファイルが保存されているSharePoint ドキュメントライブラリの名前。例:'Shared Documents'。
RemoteFile String True チェックアウトを破棄するファイルのパス。これは、完全なURL('https://yoursharepointsite.com/Shared Documents/report.docx' など)、またはライブラリ内の相対ファイル名です。

Result Set Columns

Name Type Description
Success Boolean チェックアウトが正常に破棄されたかどうかを示します。操作が成功した場合は'true' を返し、それ以外の場合は'false' を返します。

CData Cloud

MoveAttachmentOrDocument

SharePoint 内で添付ファイルやドキュメントをあるフォルダから別のフォルダに移動します。コンテンツを整理し、構造化されたドキュメントライブラリを維持するのに役立ちます。

Input

Name Type Required Description
List String True ドキュメントや添付ファイルが移動される元のSharePoint リストまたはドキュメントライブラリの名前。
SourceFileURL String True 接続プロパティのサイトURL に基づく、ソースファイルの相対URL。

フォーマット例:
ルートディレクトリファイル:/Shared Documents/filename.txt
サブディレクトリファイル:/Shared Documents/MyFolder/filename.txt
接続プロパティがサイトコレクションを指している場合、相対URL はベースサイト内のパスに対応します。特定のサイトを指している場合、相対URL はそのサイトからの相対URL となります。
DestinationFolderURL String True ドキュメントまたは添付ファイルが移動する宛先フォルダの相対URL。

フォーマット例:
ルートディレクトリ:/Shared Documents/
サブディレクトリ:/Shared Documents/MyFolder/
SourceFileURL と同様に、相対URL は接続プロパティがサイトコレクションに設定されているか、特定のサイトに設定されているかによって異なります。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。移動が正常に完了した場合は'true' を、そうでない場合は'false' を返します。

CData Cloud

RenameAttachmentOrDocument

SharePoint リストやドキュメントライブラリに保存されている添付ファイルやドキュメントの名前を変更します。ファイルの内容に影響を与えずに、命名規則を標準化するのに役立ちます。

Input

Name Type Required Description
List String True 名前を変更するドキュメントや添付ファイルを含むSharePoint リストまたはドキュメントライブラリの名前。
SourceFileURL String True 接続プロパティのサイトURL に基づく、名前を変更したいファイルの相対URL。

フォーマット例:
ルートディレクトリファイル:/Shared Documents/filename.txt
サブディレクトリファイル:/Shared Documents/MyFolder/filename.txt
接続プロパティがサイトコレクションに設定されている場合、相対URL はベースサイト内のパスに対応します。特定のサイトを指している場合、相対URL はそのサイトからの相対URL となります。
NewFileName String True ファイル拡張子を含む新しいファイル名('UpdatedFilename.docx' など)。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。ファイル名の変更に成功した場合は'true' を、失敗した場合は'false' を返します。

CData Cloud

UpdateGroup

SharePoint サイトコレクション内のグループを更新します。

Input

Name Type Required Description
Name String True グループの現在の名前。
NewName String False グループの新しい名前。
Description String True グループの説明。
OwnerName String True グループの所有者にするユーザーまたはグループのログイン名/名前。
OwnerType String True グループの所有者の種類。

使用できる値は次のとおりです。user, group

Result Set Columns

Name Type Description
Success Boolean グループが正常に更新されたかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

UpdateList

SharePoint リストのプロパティや設定を変更します。リストの構成を動的に調整するのに役立ちます。

Input

Name Type Required Description
List String True 更新されるSharePoint リストの名前またはグローバル一意識別子(GUID)。
AllowMultiResponses String False アンケートリストに複数回答を許可するには、'true' に設定します。
Description String False リストのテキストによる説明で、追加のコンテキストや目的を提供します。
Direction String False リストインターフェースのテキスト読み上げ順序を定義します:'LTR' は左から右へ、'RTL' は右から左へ、'None' は方向指定なし。

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

EnableAssignedToEmail String False 'true'に設定すると、問題追跡リストに対して割り当てられたE メール通知を有効にします。
EnableAttachments String False 'true' に設定すると、リスト内のアイテムに添付ファイルを持たせることができます。この設定はドキュメントライブラリには適用されません。
EnableModeration String False 'true' に設定すると、リスト内のアイテムのコンテンツ承認が有効になり、アイテムを表示する前に管理者のレビューが必要になります。
EnableVersioning String False 'true' に設定すると、リストアイテムのバージョン追跡が有効になり、過去の変更やロールバックができるようになります。
Hidden String False 'true' に設定すると、「ドキュメントとリスト」ページ、クイック起動、サイトコンテンツの設定などのユーザーインターフェースでリストが非表示になります。
MultipleDataList String False 'true' に設定すると、会議ワークスペース サイトのリストに複数の会議インスタンスのデータが含まれることを示します。
Ordered String False 'true' に設定すると、ユーザーが「ビューの編集」ページを使用してリスト内のアイテムを手動で並べ替えることができるようになります。
ShowUser String False 'true' に設定すると、アンケートの回答に匿名ではなくユーザー名を表示できます。
Title String False SharePoint ユーザーインターフェースに表示されるリストの表示名。

Result Set Columns

Name Type Description
Success Boolean 操作が成功したかどうかを示します。更新が正常に適用された場合は'true' を、そうでない場合は'false' を返します。

CData Cloud

UpdateListColumn

SharePoint リスト内の既存の列のプロパティを更新します。構造を再作成せずに列属性を変更するのに役立ちます。

Input

Name Type Required Description
List String True 更新する列が含まれているSharePoint リストの名前またはグローバル一意識別子(GUID)。
ColumnName String True 更新したい列の内部名。
DisplayName String False SharePoint インターフェースに表示される、列の新しい表示名。
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 Integer False 列に許可される新しい最大文字数(テキストベースのフィールドに適用されます)。
PrimaryKey Boolean False この列をリストの主キーとして指定する場合は'true' に設定します。
ReadOnly Boolean False 列を読み取り専用に設定し、新規作成または編集フォームでユーザーがその値を編集できないようにするには、'true' に設定します。
Required Boolean False アイテムを保存する前に列に値が必要な場合は、'true' に設定します。

Result Set Columns

Name Type Description
Success Boolean 列の更新が成功したかどうかを示します。操作が成功した場合は'true' を返し、それ以外の場合は'false' を返します。

CData Cloud

UpdateRole

SharePoint サイトコレクション内のロールを更新します。

Input

Name Type Required Description
Name String True ロールの現在の名前。
NewName String False ロールの新しい名前。
Description String False ロールの説明。
Permissions String False ロールに付与する権限のマスク。権限マスクの詳細については、Permissions の「権限マスク」セクションを参照してください。

Result Set Columns

Name Type Description
Success Boolean ロールが正常に更新されたかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

REST データモデル

CData Cloud はMicrosoft SharePoint データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。これらのオブジェクトへのライブ接続により、Microsoft SharePoint アカウントへのあらゆる変更はCloud に即座に反映されます。

テーブル

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

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

ビュー

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

一般的なビューには以下のものが含まれます。

テーブル 説明
AllFiles SharePoint サイト上のすべてのドキュメントライブラリにわたるすべてのファイルおよびフォルダを、メタデータの詳細を含めて取得します。監査、一括処理、データ移行に役立ちます。
AllLists ドメイン内のすべての利用可能なSharePoint リストを、システムフィールドおよびメタデータを含めてリストします。SharePoint 環境全体でリストを識別および管理するために不可欠です。
Attachments SharePoint リスト内の特定のリストアイテムに関連付けられた添付ファイルを取得します。SharePoint アイテムに関連する添付ファイルの管理および追跡に役立ちます。
Comments SharePoint アイテムに対して行われたコメントの詳細(作成者、内容、返信、メタデータなど)を含みます。ディスカッションやユーザーとのやり取りをモニタリングするのに役立ちます。
Files 特定のSharePoint リストアイテムに関連付けられたファイル添付を取得します。ファイル管理を容易にし、必要な添付ファイルにアクセスできるようにします。
Groups SharePoint サイトからグループの詳細を取得します。これには、メンバーシップ、権限、および所有権の設定が含まれます。SharePoint 内でアクセス制御とセキュリティを管理するために不可欠です。
Lists SharePoint サイト内の利用可能なリストのメタデータを取得します。これには、リストの種類や設定が含まれます。SharePoint リストの構造とその使用方法を理解するために重要です。
ListItems SharePoint リスト内のすべてのアイテムを表します。これは異なるリスト間で適用される標準列を含みます。データの一括抽出やレポート作成に便利です。
RoleAssignmentMember SharePoint サイトの権限内で特定のロールに割り当てられたメンバーの詳細を取得します。ユーザーのアクセス権を監査および管理するのに役立ちます。
RoleAssignments アクセス権を持つユーザーやグループなど、SharePoint サイトで設定されたロールの割り当てを取得します。SharePoint のセキュリティポリシーを確認および管理するのに役立ちます。
RoleDefinitionBindings SharePoint サイト内の特定のセキュリティグループやユーザーにバインドされたロール定義を一覧表示します。管理者が権限ポリシーを施行するのに役立ちます。
Roles SharePoint サイトコレクション内の権限レベルを含む、使用可能なロール定義の詳細を提供します。セキュリティロールの設定および変更に不可欠です。
Sites メタデータとサイトの詳細を含む、SharePoint サーバー内のすべての利用可能なサイトのリストを取得します。大規模なSharePoint のデプロイを管理およびナビゲートするのに便利です。
Subsites 階層とメタデータを含む、指定されたSharePoint サイトの下にあるすべてのサブサイトをリストします。SharePoint 境内でコンテンツを構造化および整理するのに役立ちます。
Users SharePoint サイトまたはグループ内のユーザーとその割り当てられたロールのリストを取得します。権限の管理とユーザー活動の追跡に重要です。

ストアドプロシージャ

ストアドプロシージャ は、SQL クエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、情報の検索、更新、および変更など、より高度なタスクも実行します。

CData Cloud

データタイプマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Microsoft SharePoint CData スキーマ
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

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

ビュー

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

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

CData Cloud - Microsoft SharePoint ビュー

Name Description
AllEvents SharePoint イベントレコードの包括的なコレクションを提供し、効果的なイベント管理のためのタイミング、場所、出席者、および関連するメタデータの詳細を示します。
AllFiles SharePoint サイト上のすべてのドキュメントライブラリにわたるすべてのファイルおよびフォルダを、メタデータの詳細を含めて取得します。監査、一括処理、データ移行に役立ちます。
AllLists ドメイン内のすべての利用可能なSharePoint リストを、システムフィールドおよびメタデータを含めてリストします。SharePoint 環境全体でリストを識別および管理するために不可欠です。
AllPages SharePoint サイトページの包括的なコレクションを表示し、効果的なページ管理のためのコンテンツ、レイアウト、作成情報、権限、および関連するメタデータに関する詳細を提供します。
Attachments SharePoint リスト内の特定のリストアイテムに関連付けられた添付ファイルを取得します。SharePoint アイテムに関連する添付ファイルの管理および追跡に役立ちます。
Comments SharePoint アイテムに対して行われたコメントの詳細(作成者、内容、返信、メタデータなど)を含みます。ディスカッションやユーザーとのやり取りをモニタリングするのに役立ちます。
Files 特定のSharePoint リストアイテムに関連付けられたファイル添付を取得します。ファイル管理を容易にし、必要な添付ファイルにアクセスできるようにします。
Groups SharePoint サイトからグループの詳細を取得します。これには、メンバーシップ、権限、および所有権の設定が含まれます。SharePoint 内でアクセス制御とセキュリティを管理するために不可欠です。
Lists SharePoint リストを返します。
ListItems SharePoint リスト内のすべてのアイテムを表します。これは異なるリスト間で適用される標準列を含みます。データの一括抽出やレポート作成に便利です。
RoleAssignmentMember SharePoint サイトの権限内で特定のロールに割り当てられたメンバーの詳細を取得します。ユーザーのアクセス権を監査および管理するのに役立ちます。
RoleAssignments アクセス権を持つユーザーやグループなど、SharePoint サイトで設定されたロールの割り当てを取得します。SharePoint のセキュリティポリシーを確認および管理するのに役立ちます。
RoleDefinitionBindings SharePoint サイト内の特定のセキュリティグループやユーザーにバインドされたロール定義を一覧表示します。管理者が権限ポリシーを施行するのに役立ちます。
Roles SharePoint サイトコレクション内の権限レベルを含む、使用可能なロール定義の詳細を提供します。セキュリティロールの設定および変更に不可欠です。
Sites SharePoint サーバー内で利用可能なすべてのサイトのリストをメタデータとサイトの詳細を含めて取得します。大規模なSharePoint 環境の管理とナビゲーションに役立ちます。
Subsites 指定されたSharePoint サイト配下のすべてのサブサイトを階層とメタデータを含めて一覧表示します。SharePoint 環境内でのコンテンツの構造化と整理に役立ちます。
Users SharePoint サイトまたはグループ内のユーザーとその割り当てられたロールのリストを取得します。権限の管理とユーザー活動の追跡に重要です。

CData Cloud

AllEvents

SharePoint イベントレコードの包括的なコレクションを提供し、効果的なイベント管理のためのタイミング、場所、出席者、および関連するメタデータの詳細を示します。

Columns

Name Type References Description
SiteURL [KEY] String

Sites.SiteURL

イベントリストが存在するSharePoint サイトの URL。
EventListId [KEY] String ライブラリの一意識別子。
EventId [KEY] Int イベントアイテムの一意識別子。
Category String イベントの分類カテゴリ。
Title String イベントのタイトルまたは件名。
Name String イベントアイテムの表示名。
Attendees String イベントの出席者識別子のコレクション。
StartTime Datetime イベントの開始時刻。
EndTime Datetime イベントの終了時刻。
IsAllDayEvent Bool イベントが終日スケジュールされているかどうかを示します。
Availability String イベントの予定の状態(空き時間または予定あり)。
Attachments Bool イベントアイテムに添付ファイルがあるかどうかを示します。
EventCancelled Bool イベントがキャンセルされたかどうかを示します。
EventType Int イベントの分類タイプ。
Duration Int イベントの期間(通常は分単位)。
EncodedAbsoluteURL String イベントアイテムにアクセスするためのエンコードされた絶対URL。
ServerRelativeURL String イベントアイテムにアクセスするためのサーバー相対URL。
Path String SharePoint 内のイベントアイテムのサーバーファイルパス。
CreatedBy Int イベントアイテムを作成したユーザーの識別子。
ModifiedBy Int イベントレコードを最後に変更したユーザーの識別子。
Created Datetime イベントアイテムが作成されたタイムスタンプ。
Modified Datetime イベントレコードが最後に更新されたタイムスタンプ。
Description String イベントの詳細な説明。
ContentTypeID String イベントアイテムに適用されるコンテンツ タイプの一意識別子。
ItemType Int SharePoint アイテムタイプ(例:ファイル、フォルダ) 0: ファイル、1: フォルダ。
FileName String イベントレコードに関連付けられたファイルの表示名。
Resources String イベント用に予約された関連リソースまたは施設。
Location String イベントが開催される物理的または仮想的な場所。
ApproverComments String イベントアイテムに関する承認者のコメント。
ApprovalStatus Int イベントアイテムの現在の承認状態。0: 承認済み、1: 却下、2: 保留中、3: 下書き。
CheckDoubleBooking String イベントの二重予約の可能性にフラグを設定するために使用されるインジケーター。
HiddenParticipants String イベントの公開参加者リストから非表示になっている参加者のリスト。
EffectivePermissionsMask String イベントアイテムの有効な権限を表す権限マスク。
PrincipalCount String イベントアイテムの権限に関連付けられているプリンシパル(ユーザーまたはグループ)の数。
IsRecurring Bool イベントが定期的なものかどうかを示します。
RecurrenceData String イベントの定期的なパターンを定義するXML データ。
TimeZone Int イベントのタイミングに適用されるタイムゾーン識別子。
GUID String イベントアイテムのグローバル一意識別子(GUID)。
UniqueId String イベントレコードの読み取り専用GUID。
BannerImageURL String 視覚的表現のためにイベントに関連付けられたバナー画像のURL。
BannerURL String イベントのバナー画像のハイパーリンクURL。
BannerDescription String イベントのバナーハイパーリンクの説明テキスト。

Pseudo-Columns

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

Name Type Description
ItemCount Int AllLists ビューに伝達されるフィルタ。

CData Cloud

AllFiles

SharePoint サイト上のすべてのドキュメントライブラリにわたるすべてのファイルおよびフォルダを、メタデータの詳細を含めて取得します。監査、一括処理、データ移行に役立ちます。

テーブル固有の情報

Select

[Sites] テーブルにリストされているサイトからすべてのアイテムを取得します。

SELECT [*] 
FROM [AllFiles];

指定されたサイトURL からすべてのアイテムを取得します。

SELECT [*] 
FROM [AllFiles] 
WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/';

指定されたサイト内の特定のライブラリからすべてのアイテムを取得します。

SELECT [*] 
FROM [AllFiles] 
WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite' 
  AND [LibraryId] = 'YourLibraryId';

指定されたライブラリおよびサイト内のファイルの特定の列を取得します。

SELECT [SiteURL], [LibraryId], [FileId], [Name] 
FROM [AllFiles] 
WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite' 
  AND [Name] = 'YourFileName.txt';

指定されたサイト内の複数の特定のライブラリからすべてのアイテムを取得します。

SELECT [*] 
FROM [AllFiles] 
WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite' 
  AND [LibraryId] IN ('LibraryId1', 'LibraryId2', 'LibraryId3');

Columns

Name Type References Description
SiteURL [KEY] String

Sites.SiteURL

ファイルが保存されているSharePoint サイトの完全なURL。ファイルのサイトコンテキストを識別するのに役立ちます。
LibraryId [KEY] String ファイルを含むドキュメントライブラリの一意の識別子。特定のライブラリに基づくファイルのフィルタリングに役立ちます。
FileId [KEY] Int SharePoint 内のファイルに割り当てられた一意の数値識別子。プログラムでファイルを参照するのに役立ちます。
Name String 拡張子を含むファイル名。ファイルの識別と整理に重要です。
Title String ファイルのタイトルメタデータ。ファイル名とは異なる場合があります。ユーザーフレンドリーなファイル記述によく使用されます。
FileSize String ファイルのバイトサイズ。ストレージ使用量の追跡や大容量ファイルの管理に役立ちます。
FileType String .docx、.pdf、.xlsx などのファイルの拡張子や種類。形式ごとにファイルを分類し、フィルタリングするのに役立ちます。
ItemType Int SharePoint アイテムの種類を示します。有効な値は次のとおりです:Invalid (-1)、File (0)、Folder (1)、Web (2)。ファイルとフォルダを区別するのに役立ちます。
Description String ファイルのより詳細な説明(提供されている場合)。ファイル名やタイトル以外のコンテキストをファイルに追加するのに役立ちます。
Path String SharePoint ライブラリ内のファイルパス。構造化された階層内でファイルを探すのに役立ちます。
ServerRelativeURL String SharePoint サイトのルートに対するファイルの相対URL。SharePoint 内での内部リンクに役立ちます。
EncodedAbsoluteURL String Web アプリケーションで使用するためにエンコードされたファイルの完全な絶対URL。外部からファイルにアクセスするために不可欠です。
CheckedOutTo Int ファイルをチェックアウトした人のユーザーID。ドキュメントの所有権と編集の管理を追跡するのに役立ちます。
CheckInComment String ファイルが最後にチェックインされたときに提供されたコメント。バージョン履歴と変更を追跡するのに役立ちます。
Version String ファイルのバージョン番号。ドキュメントの改訂を管理し、以前のバージョンを取得するのに役立ちます。
ContentTypeID String ファイルに関連付けられたコンテンツタイプの一意の識別子。メタデータ管理とワークフローの自動化に重要です。
UniqueId String SharePoint が生成したファイルの一意識別子。ワークフローやAPI リクエストでファイルを参照するのに役立ちます。
GUID String ファイルに割り当てられたグローバル一意識別子(GUID)。SharePoint 環境全体にわたる明確な識別を実現します。
Created Datetime ファイルが最初に作成された日時。ドキュメントのライフサイクルの追跡や監査の目的に役立ちます。
CreatedBy String ファイルを作成した人のユーザー名。オーサーシップとアカウンタビリティを監視する上で重要です。
Modified Datetime ファイルが最後に変更された日時。直近の変更や更新の追跡に役立ちます。
ModifiedBy String ファイルを最後に変更した人のユーザー名。最新の投稿を追跡するのに便利です。

Pseudo-Columns

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

Name Type Description
ItemCount Int AllLists ビューに伝播されるフィルタとして機能します。

CData Cloud

AllLists

ドメイン内のすべての利用可能なSharePoint リストを、システムフィールドおよびメタデータを含めてリストします。SharePoint 環境全体でリストを識別および管理するために不可欠です。

Columns

Name Type References Description
SiteURL [KEY] String

Sites.SiteURL

リストが保存されているSharePoint サイトの完全なURL。リストのサイトコンテキストを識別するのに役立ちます。
Id [KEY] String リストの一意の識別子。API や自動化スクリプトを使用する際にリストを区別するのに役立ちます。
Title String リストの表示名。ユーザーがリストを識別しやすくするために役立ちます。
BaseTemplate Int リストを作成するために使用されるテンプレートの種類。例えば、ドキュメントライブラリ、タスクリスト、またはカレンダーなど。リストの機能を決定するのに役立ちます。
BaseType Int リストの基本タイプを示します。例えば、汎用リストやライブラリなど。リストを分類するのに役立ちます。
Description String リストの簡単な説明。リストの目的や使用方法に関するコンテキストを提供します。
Hidden Bool リストが標準のSharePoint ビューで非表示になっているかどうかを示します。バックグラウンドプロセス用のリストかどうかを判断するのに役立ちます。
AllowDeletion Bool リストが削除可能かどうかを示します。重要なリストを誤って削除されないように保護するのに役立ちます。
ItemCount Int リストに保存されているアイテムの総数。リストの使用状況やパフォーマンスを監視するのに役立ちます。
Created Datetime リストが最初に作成された日時。そのリストのライフスパンを追跡するのに役立ちます。
LastItemDeletedDate Datetime リストから最後にアイテムが削除された日時。直近の削除を追跡するのに役立ちます。
LastItemModifiedDate Datetime リスト内のアイテムに最後に変更が加えられた日時。最近のアクティビティを特定するのに役立ちます。
LastItemUserModifiedDate Datetime ユーザーによって最後に変更が加えられた日時。システムによる変更とユーザーによる変更を区別するのに役立ちます。
HasUniqueRoleAssignments Bool リストが親サイトから権限を継承するのではなく、カスタム権限設定を持っているかどうかを示します。セキュリティ管理において重要です。
DefaultDisplayFormUrl String リストアイテムを表示するためのデフォルト表示フォームのURL。ナビゲーションとフォームのカスタマイズに役立ちます。
DefaultEditFormUrl String リストアイテムを変更するためのデフォルト編集フォームのURL。正しい編集ページへのリンクに役立ちます。
DefaultNewFormUrl String 新しいリストアイテムを作成するためのデフォルトフォームのURL。ユーザーをアイテム作成ページに誘導するのに役立ちます。
DefaultViewPath_DecodedUrl String リストのデフォルトビューパスのデコードされたURL。リストの標準ビューにアクセスするのに役立ちます。
DefaultViewUrl String リストのデフォルトビューのURL。メインリストビューへの迅速なアクセスに役立ちます。
DisableCommenting Bool リストに対するコメントが無効化されているかどうかを示します。コラボレーション設定の管理に役立ちます。
DocumentTemplateUrl String リストで新しいファイルを作成する際に使用されるデフォルトのドキュメントテンプレートのURL。ドキュメントライブラリにとって重要です。
EnableAttachments Bool リストアイテムに添付ファイルが許可されているかどうかを示します。リスト内のファイルアップロードを管理するのに役立ちます。
EnableFolderCreation Bool ユーザーがリスト内にフォルダを作成できるかどうかを示します。コンテンツ階層を構築するために重要です。
EntityTypeName String リストに関連付けられたエンティティタイプ名。API のやり取りと自動化に役立ちます。
ImagePath_DecodedUrl String リストに関連付けられた画像のデコードされたURL。ブランディングと視覚的識別に役立ちます。
ImageUrl String リストを表す画像のURL。リストのユーザーフレンドリーな表示に役立ちます。
IsApplicationList Bool リストがアプリケーションの一部として使用されているかどうかを示します。標準リストとシステム生成リストを区別するのに役立ちます。
IsCatalog Bool リストがカタログとして機能するかどうかを示します。製品やリソースのディレクトリを管理するのに役立ちます。
IsDefaultDocumentLibrary Bool リストがサイトの主要なドキュメントライブラリであるかどうかを示します。メインストレージの場所を特定するのに便利です。
IsPrivate Bool リストがプライベートであり、すべてのユーザーがアクセスできないかどうかを示します。セキュリティとデータ保護を強化するのに役立ちます。
IsSystemList Bool リストがSharePoint 内部で使用されるシステム生成リストであるかどうかを示します。意図しない変更を避けるのに役立ちます。
ListFormCustomized Bool リストのフォームがカスタマイズされているかどうかを示します。UI のカスタマイズを追跡するために重要です。
ListItemEntityTypeFullName String リストアイテムに関連付けられた完全なエンティティタイプ名。統合やAPI の使用に役立ちます。
ParentWebPath_DecodedUrl String リストを含む親サイトのデコードされたURL。階層的なサイト関係を特定するのに役立ちます。
ParentWebUrl String リストを含む親サイトのURL。ナビゲーションと組織化に役立ちます。
ReadSecurity Int リストに適用される読み取りセキュリティのレベルを指定します。リスト内のアイテムを誰が閲覧できるかを制御します。
ServerTemplateCanCreateFolders Bool サーバーテンプレートがリスト内でフォルダの作成を許可するかどうかを示します。コンテンツの構造化を管理するのに役立ちます。

CData Cloud

AllPages

SharePoint サイトページの包括的なコレクションを表示し、効果的なページ管理のためのコンテンツ、レイアウト、作成情報、権限、および関連するメタデータに関する詳細を提供します。

Columns

Name Type References Description
SiteURL [KEY] String

Sites.SiteURL

Wiki ページリストをホストするSharePoint サイトのベースURL。
PageListId [KEY] String Wiki ページを含むWiki ページリスト(ライブラリ)の一意識別子。
PageId [KEY] Int Wiki ページアイテムの一意識別子。
Name String SharePoint に格納されているWiki ページアイテムのファイル名。
Title String Wiki ページアイテムの表示タイトル。
FileSize String Wiki ページアイテムのファイルサイズを表す表示文字列。
FileType String Wiki ページアイテムのファイルタイプまたは拡張子。
ItemType Int SharePoint アイテムのタイプを指定します。列挙値:0 = ファイル、1 = フォルダ。
PageLayoutType String Wiki ページのレイアウトタイプを指定し、デザインと構造を決定します。
PrincipalCount String ページアイテムの権限に関連付けられているプリンシパル(ユーザーまたはグループ)の数。
EncodedAbsoluteURL String Wiki ページアイテムにアクセスするために使用される完全にエンコードされたURL。
ServerRelativeURL String Wiki ページアイテムへのサーバー相対URL パス。
Path String SharePoint 内でWiki ページアイテムが格納されているサーバーファイルパス。
ContentTypeID String Wiki ページアイテムに適用されたコンテンツタイプの一意識別子。
PromotedState Double Wiki ページの昇格状態を指定します。列挙値:0 = 通常ページ(昇格されていない)、2 = 昇格されたページ(注目ページやニュースページなど)。
EffectivePermissionsMask String このWiki ページアイテムに対する現在のユーザーの有効な権限を表す権限マスク。
CreatedBy String Wiki ページアイテムに関連付けられたドキュメントを作成したユーザーの表示名。
CreatedById Int Wiki ページアイテムを作成したユーザーの識別子。
ModifiedBy String Wiki ページアイテムに関連付けられたドキュメントを最後に変更したユーザーの表示名。
ModifiedById Int Wiki ページアイテムを最後に変更したユーザーの識別子。
Created Datetime Wiki ページアイテムが作成された日時。
Modified Datetime Wiki ページアイテムが最後に変更された日時。
Description String Wiki ページコンテンツの簡単な説明または概要。
BannerImageDescription String Wiki ページアイテムのバナー画像に関連付けられた説明テキスト。
BannerImageURL String Wiki ページアイテムに関連付けられたバナー画像のURL。
GUID String Wiki ページアイテムのグローバル一意識別子(GUID)。
UniqueId String Wiki ページアイテムのGUID とは異なる読み取り専用のグローバル一意識別子。
PageLayoutContent String Wiki ページのレイアウトとWeb パーツを定義するXML またはHTML。
AuthoringCanvasContent String Wiki ページのWeb パーツの配置を詳細に示す、作成キャンバスのコンテンツと構成。
WikiContent String 通常Wiki マークアップまたはHTML で記述されたWiki ページの主要なテキストコンテンツ。

Pseudo-Columns

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

Name Type Description
ItemCount Int AllLists ビューに伝達されるフィルタ。

CData Cloud

Attachments

SharePoint リスト内の特定のリストアイテムに関連付けられた添付ファイルを取得します。SharePoint アイテムに関連する添付ファイルの管理および追跡に役立ちます。

テーブル固有の情報

Select

Note:Attachment を返すにはList とItemId が必要です。

List はLists ビュー(Title 列)から取得できます。

SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1

Columns

Name Type References Description
Id [KEY] String リストアイテムに関連付けられた添付ファイルの一意の識別子。自動化およびAPI コールで添付ファイルを参照するのに役立ちます。
Updated Datetime 添付ファイルが最後に変更された日時。ファイル添付の最近の更新を追跡するのに役立ちます。
FileName String 拡張子を含む添付ファイルの名前。添付ファイルの識別と管理に役立ちます。
FileExtension String 添付ファイルの拡張子。
ServerRelativePath_DecodedUrl String 添付ファイルのデコードされたサーバー相対パス。SharePoint 内で添付ファイルにアクセスするためのURL を構築するのに役立ちます。
FileNameAsPath_DecodedUrl String 添付ファイル名のデコードされたファイルパス表現。プログラムで添付ファイルを参照するのに役立ちます。
ServerRelativeUrl String 添付ファイルのサーバー相対URL。SharePoint 内で内部リンク用のファイルへの直接パスを提供します。
ItemURL String 添付ファイルの閲覧可能なリンク。
List String

Lists.Title

添付ファイルを含むSharePoint リストの内部名。添付ファイルを取得する際にソースリストを識別するのに役立ちます。
ItemID Int 添付ファイルが属するリストアイテムの一意の識別子。特定のレコードに添付ファイルをリンクするのに役立ちます。

CData Cloud

Comments

SharePoint アイテムに対して行われたコメントの詳細(作成者、内容、返信、メタデータなど)を含みます。ディスカッションやユーザーとのやり取りをモニタリングするのに役立ちます。

ビュー固有の情報

Comments ビューからレコードを取得するには、List 列とItemId 列の両方を指定する必要があります。これらは、コメントにアクセスしたいリストアイテムを識別します。

サンプルクエリ

次のクエリは、list1 リストのItemId = 1 のアイテムのコメントを取得します。

SELECT * FROM CData.REST.Comments WHERE List = 'list1' AND ItemId = 1;

Columns

Name Type References Description
Id [KEY] Int 各コメントの一意の数値識別子。ワークフローやAPI クエリで特定のコメントを参照するのに役立ちます。
ItemId [KEY] Int

ListItems.Id

コメントが関連付けられているSharePoint アイテムのID。コメントをそれぞれのリストアイテムにリンクするのに役立ちます。
List String

Lists.Title

コメントが付けられたアイテムを含むSharePoint リストの名前。コメントのリストコンテキストを識別するのに役立ちます。
ListId String コメントを含むSharePoint リストの一意の識別子。コメントを取得する際にリストを区別するのに役立ちます。
AuthorId Int コメントを作成したユーザーの一意の識別子。作成者と権限を追跡するのに役立ちます。
AuthorEmail String コメントを投稿したユーザE メールアドレス。コメント投稿者を特定して連絡するのに役立ちます。
IsReply Bool コメントが別のコメントへの返信であるかどうかを示します。スレッド形式のディスカッションを構築するのに役立ちます。
ParentId Int

Comments.Id

このコメントが返信である場合の親コメントのID。ネストされた会話におけるコメント階層の維持に役立ちます。
ReplyCount Int コメントへの返信の総数。エンゲージメントとディスカッションのアクティビティを追跡するのに役立ちます。
LikeCount Int コメントが受け取った「いいね」の総数。コメントの人気度を測定するのに役立ちます。
IsLikedByUser Bool 現在のユーザーがコメントに「いいね」したかどうかを示します。ユーザーインタラクションをパーソナライズするのに役立ちます。
Text String コメントの全文。ユーザーインターフェースにコメントを表示するために不可欠です。
Mentions String コメントでメンションされたユーザーのリストで、カンマで区切られています。ディスカッションでメンションされたユーザーに通知するのに役立ちます。
CreatedDate Datetime コメントが最初に投稿された日時。コメント履歴を追跡するのに役立ちます。
ModifiedDate Datetime コメントが最後に編集された日時。変更の監査と更新の追跡に役立ちます。

CData Cloud

Files

特定のSharePoint リストアイテムに関連付けられたファイル添付を取得します。ファイル管理を容易にし、必要な添付ファイルにアクセスできるようにします。

Columns

Name Type References Description
Id [KEY] String SharePoint ファイルの一意の識別子。プログラムでファイルを追跡および参照するのに役立ちます。
CreatedBy_Id String ファイルをアップロードしたユーザーの一意のID。ファイルの所有権と権限を追跡するのに役立ちます。
CreatedBy_Name String ファイルをアップロードしたユーザーのフルネーム。ユーザーフレンドリーなメタデータを表示するのに役立ちます。
CreatedBy_Puid String ファイルを追加したユーザーの個人識別子。エンタープライズ環境でのID 管理に役立ちます。
ETag String バージョン管理に使用されるエンティティタグ(ETag)値。ファイルの変更を検出し、更新のコンフリクトを防ぐのに役立ちます。
LastModifiedBy_Id String ファイルを最後に変更したユーザーの一意のID。変更の監査と最近の編集の追跡に役立ちます。
LastModifiedBy_Name String ファイルを最後に変更したユーザーのフルネーム。ドキュメントのコントリビューターを特定するのに役立ちます。
LastModifiedBy_Puid String ファイルを最後に変更したユーザーの個人識別子。セッションをまたいで一意のユーザーを区別するのに役立ちます。
Name String ファイル名。拡張子を含みます(例:'document.pdf')。ファイルの識別に不可欠です。
Size Long バイト単位のファイルサイズで、ファイル内で使用されているWeb パーツを除きます。ストレージ使用量の監視と大容量ファイルの管理に役立ちます。
TimeCreated Datetime ファイルが最初に作成された日時。ドキュメント履歴と保持ポリシーを追跡するのに役立ちます。
TimeLastModified Datetime ファイルが最後に変更された日時。ファイルの最新の更新を確認するのに役立ちます。
Url String ファイルの完全なURL。SharePoint 内での直接アクセスとリンクに役立ちます。
List String ファイルが保存されているSharePoint リストまたはライブラリの表示名。ファイルの効率的な整理と取得に役立ちます。

CData Cloud

Groups

SharePoint サイトからグループの詳細を取得します。これには、メンバーシップ、権限、および所有権の設定が含まれます。SharePoint 内でアクセス制御とセキュリティを管理するために不可欠です。

Columns

Name Type References Description
Id [KEY] Int SharePoint グループの一意の識別子。グループの権限を管理し、グループの詳細を取得するのに役立ちます。
LoginName String グループに関連付けられたログイン名またはエイリアス。認証およびグループベースのアクセス制御の管理に役立ちます。
Title String グループの表示名。SharePoint のUI でユーザーフレンドリーなグループ名を表示するのに役立ちます。
AllowMembersEditMembership Bool グループメンバーがユーザーを追加または削除する権限を持っているかどうかを示します。メンバー管理ポリシーを決定するのに役立ちます。
AllowRequestToJoinLeave Bool ユーザーがグループに参加または退出をリクエストできるかどうかを示します。オープンまたは制限されたメンバーシップ設定を管理するのに役立ちます。
AutoAcceptRequestToJoinLeave Bool メンバーシップリクエストが自動的に承認されるかどうかを示します。セルフサービスのグループ管理に役立ちます。
CanCurrentUserEditMembership Bool 現在ログインしているユーザーがグループのメンバーシップを編集する権限を持っているかどうかを示します。ユーザー固有の権限を決定するのに役立ちます。
CanCurrentUserManageGroup Bool 現在のユーザーがグループの管理権限を持っているかどうかを示します。管理アクセスレベルを決定するのに役立ちます。
CanCurrentUserViewMembership Bool 現在のユーザーがグループのメンバーシップの詳細を表示できるかどうかを示します。セキュリティ設定とアクセス制御を強化するのに役立ちます。
Description String グループの目的や機能の簡単な概要。SharePoint 内でのグループの役割についてのコンテキストを提供するのに役立ちます。
IsHiddenInUI Bool グループがSharePoint ユーザーインターフェースで非表示になっているかどうかを示します。システムまたはバックグラウンドグループの可視性を制御するのに役立ちます。
OnlyAllowMembersViewMembership Bool グループメンバーのみがメンバーシップの詳細を表示できるかどうかを示します。プライバシーとセキュリティ設定を維持するのに役立ちます。
OwnerTitle String グループの所有者の表示名。グループの管理を担当する人物を特定するのに役立ちます。
RequestToJoinLeaveEmailSetting String グループへの参加または退出のリクエストが送信されるE メールアドレス。グループメンバーシップの承認を管理するのに役立ちます。
PrincipalType Int グループに関連付けられたプリンシパルの種類を指定します。設定可能な値は以下のとおりです:None (0)、User (1)、DistributionList (2)、SecurityGroup (4)、SharePointGroup (8)、All (15)。異なる種類のグループやユーザーを分類するのに役立ちます。

CData Cloud

Lists

SharePoint リストを返します。

テーブル固有の情報

Lists を使用して、SharePoint のテーブルをリストできます。これは、SharePoint 内の実際のリストだけを返します。Cloud に関連付けられた特別なテーブルは返しません。

WHERE 句で次の列を使用できます:Title およびBaseTemplage。

Columns

Name Type References Description
Id [KEY] String データベース内のリストを識別するGUID。
EntityTypeName String リストのエンティティタイプ名。
Title String リストの表示タイトル。
AdditionalUXProperties String リストに関連付けられた追加のユーザーエクスペリエンスプロパティ。
AllowContentTypes Bool リストがコンテンツタイプをサポートするかどうかを指定します。
AllowDeletion Bool リストが削除を許可するかどうかを指定します。
BaseTemplate Int リストの基になるリスト定義タイプ。ListTemplateType 値を表します。
BaseType Int リストの基本タイプ。SP.BaseType 値を表します: 汎用リスト = 0、ドキュメントライブラリ = 1、ディスカッション掲示板 = 3、アンケート = 4、課題 = 5。
BrowserFileHandling Int リストレベルでのWeb アプリケーションのBrowserFileHandling プロパティのオーバーライド: Permissive = 0、Strict = 1。
Color String リストに関連付けられた色の値。
ContentTypesEnabled Bool リストでコンテンツタイプが有効になっているかどうかを指定します。
CrawlNonDefaultViews Bool リストの既定以外のビューが検索クロールに含まれるかどうかを指定します。
Created Datetime リストが作成された日時。
DefaultContentApprovalWorkflowId String リストのコンテンツ承認用の既定のワークフロー識別子。既定のコンテンツ承認ワークフローがない場合は空のGUID を返します。
DefaultDisplayFormURL String リストの既定の表示フォームの場所。クライアントはサーバー相対URL を指定し、サーバーはサイト相対URL を返します。
DefaultEditFormURL String リスト内のリストアイテムに使用する編集フォームのURL。クライアントはサーバー相対URL を指定し、サーバーはサイト相対URL を返します。
DefaultItemOpenInBrowser Bool リストアイテムが既定でブラウザで開かれるかどうかを指定します。
DefaultItemOpenUseListSetting Bool リスト設定がアイテムを既定で開く方法を決定するかどうかを指定します。
DefaultNewFormURL String リストの既定の新規フォームの場所を指定する値を取得または設定します。クライアントはサーバー相対URL を指定し、サーバーはサイト相対URL を返します。
DefaultViewPath_DecodedURL String リストの既定のビューパスのデコードされたURL。
DefaultViewURL String リストの既定のビューのURL。
Description String リストの説明。
Direction String リストの読み取り順序。NONE、LTR、またはRTL を返します。
DisableCommenting Bool リスト内のアイテムに対するコメントが無効になっているかどうかを指定します。
DisableGridEditing Bool リストでグリッド編集が無効になっているかどうかを指定します。
DocumentTemplateURL String リストのドキュメントテンプレートのサーバー相対URL。基本タイプがDocumentLibrary の場合はサーバー相対URL を返し、それ以外の場合はnull を返します。
DraftVersionVisibility Int リスト内のマイナーバージョンと下書きを表示するために必要な最小権限: 読み取り = 0、作成者 = 1、承認者 = 2。
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 リストアイテムとドキュメントの履歴バージョンをリストで作成できるかどうかを指定します。
ExcludeFromOfflineClient Bool リストがオフラインクライアントから除外されるかどうかを指定します。
ExcludeFromOfflineMode Bool リストがオフラインモードから除外されるかどうかを指定します。
ExemptFromBlockDownloadOfNonViewableFiles Bool リストが表示不可能なファイルのブロックダウンロードポリシーから除外されるかどうかを指定します。
FileSavePostProcessingEnabled Bool リストにファイルを保存するときに後処理が有効になっているかどうかを指定します。
ForceCheckout Bool ドキュメントライブラリで強制チェックアウトが有効になっているかどうかを指定します。
HasContentAssemblyTemplates Bool リストにコンテンツアセンブリテンプレートがあるかどうかを指定します。
HasExternalDataSource Bool リストが外部リストかどうかを指定します。
HasFolderColoringFields Bool リストにフォルダーの色付けフィールドがあるかどうかを指定します。
HasListBoundContentAssemblyTemplates Bool リストにリストにバインドされたコンテンツアセンブリテンプレートがあるかどうかを指定します。
HasUniqueRoleAssignments Bool ロールの割り当てがこのセキュリティ保護可能なオブジェクトに対して一意に定義されているか、親のセキュリティ保護可能なオブジェクトから継承されているかを指定します。
Hidden Bool リストが非表示かどうかを指定します。true の場合、サーバーはOnQuickLaunch プロパティをfalse に設定します。
HighPriorityMediaProcessing Bool リストで優先度の高いメディア処理が有効になっているかどうかを指定します。
Icon String リストに関連付けられたアイコン。
ImagePath_DecodedURL String リストの画像パスのデコードされたURL。
ImageURL String リストのアイコンのURL。
IrmEnabled Bool リストでIRM が有効になっているかどうかを指定します。
IrmExpire Bool リストでIRM の有効期限が有効になっているかどうかを指定します。
IrmReject Bool リストでIRM の拒否が有効になっているかどうかを指定します。
IsApplicationList Bool クライアントアプリケーションがリストを表示するかどうかを決定するために使用できるフラグを指定します。
IsCatalog Bool リストがギャラリーかどうかを指定します。
IsContributorOwnerEnabled Bool リストで投稿者所有者機能が有効になっているかどうかを指定します。
IsDefaultDocumentLibrary Bool リストが既定のドキュメントライブラリかどうかを指定します。
IsPredictionModelApplied Bool リストに予測モデルが適用されているかどうかを指定します。
IsPrivate Bool リストがプライベートかどうかを指定します。
IsSystemList Bool リストがシステムリストかどうかを指定します。
ItemCount Int リスト内のアイテムの数。
LastItemDeletedDate Datetime リストからリストアイテムが削除された最後の日時。
LastItemModifiedDate Datetime リストアイテム、フィールド、またはリストのプロパティが変更された最後の日時。
LastItemUserModifiedDate Datetime リストアイテム、フィールド、またはリストのプロパティがユーザーによって最後に変更された日時。
ListExperienceOptions Int リストのエクスペリエンスオプション。
ListFormCustomized Bool リストフォームがカスタマイズされているかどうかを指定します。
ListItemEntityTypeFullName String リストアイテムの完全なエンティティタイプ名。
ListSchemaVersion Int リストのスキーマバージョン。
MajorVersionLimit Int リスト内のアイテムに許可されるメジャーバージョンの制限。
MajorWithMinorVersionsLimit Int リスト内のアイテムに許可されるマイナーバージョン付きメジャーバージョンの制限。
MultipleDataList Bool 会議ワークスペースサイト内のリストに、サイト内の複数の会議インスタンスのデータが含まれているかどうかを指定します。
NoCrawl Bool クローラーがリストをクロールしてはならないことを指定します。
OnQuickLaunch Bool リストがサイトのクイック起動に表示されるかどうかを指定します。true の場合、サーバーはHidden プロパティをfalse に設定します。
PageRenderType Int リストのページレンダリングタイプ。
ParentWebPath_DecodedURL String リストの親Web パスのデコードされたURL。
ParentWebURL String リストを含むサイトのサーバー相対URL を指定します。
ParserDisabled Bool リストでパーサーが無効になっているかどうかを指定します。
ReadSecurity Int リストの読み取りセキュリティ設定。
SchemaXML String XML として表されたリストスキーマ。
ServerRelativeURL String サーバー相対URL。
ServerTemplateCanCreateFolders Bool リスト内でフォルダーを作成できるかどうかを指定します。
ShowHiddenFieldsInModernForm Bool リストのモダンフォームで非表示フィールドが表示されるかどうかを指定します。
TemplateFeatureId String リストのリストスキーマを含むフィーチャーの識別子。リストスキーマがフィーチャー内に含まれていない場合は空のGUID を返します。
TemplateTypeId String リストのテンプレートタイプ識別子。
ValidationFormula String リストアイテムのデータ検証条件。
ValidationMessage String リストアイテムのデータ検証が失敗したときに返されるエラーメッセージ。
WriteSecurity Int リストの書き込みセキュリティ設定。

CData Cloud

ListItems

SharePoint リスト内のすべてのアイテムを表します。これは異なるリスト間で適用される標準列を含みます。データの一括抽出やレポート作成に便利です。

ビュー固有の情報

ListItems ビューからレコードを取得するには、List 列を指定する必要があります。これは、アイテムを取得するMicrosoft SharePoint リストを特定します。

サンプルクエリ

次のクエリは、List1 という名前のリストからすべてのアイテムを取得します。

SELECT * FROM CData.REST.ListItems WHERE List = 'List1';

Columns

Name Type References Description
ID [KEY] Int リストアイテムに割り当てられる一意の数値識別子。ワークフローやAPI クエリで特定のアイテムを参照するのに便利です。
Title String リストアイテムのタイトルまたは名前。リスト内のアイテムを迅速に識別し、整理するのに役立ちます。
Attachments Bool リストアイテムに1つ以上の添付ファイルがあるかどうかを示します。関連するドキュメントやファイルを管理するのに役立ちます。
Description String リストアイテムの詳細な説明。アイテムに追加のコンテキストやメタデータを提供するのに役立ちます。
List [KEY] String

Lists.Title

アイテムを含むSharePoint リストの表示名。アイテムを取得する際にソースリストを識別するのに役立ちます。
ContentTypeID String アイテムに関連付けられたコンテンツタイプの識別子。メタデータ構造を強制し、アイテムの種類を定義するのに役立ちます。
FileSystemObjectType Int ファイルシステム内のオブジェクトの種類を示します。有効な値は次のとおりです:'-1' (Invalid)、'0' (File)、'1' (Folder)、'2' (Web)。ファイル、フォルダ、サイトコンポーネントを区別するのに役立ちます。
GUID String アイテムに割り当てられるグローバル一意識別子(GUID)。SharePoint 環境全体にわたる明確な識別を実現します。
Version String アイテムのバージョン番号で、改訂履歴を示します。変更の追跡やロールバックに便利です。
CreatedBy Int

Users.Id

アイテムを作成したユーザーの一意の識別子。作成者と権限を追跡するのに役立ちます。
ModifiedBy Int

Users.Id

アイテムを最後に編集したユーザーの一意の識別子。最近の変更やユーザーの貢献を監視するのに役立ちます。
Created Datetime アイテムが最初に作成された日時。アイテムのライフサイクルの追跡や変更の監査に便利です。
Modified Datetime アイテムが最後に変更された日時。最近の更新を識別し、バージョン履歴を維持するのに役立ちます。

CData Cloud

RoleAssignmentMember

SharePoint サイトの権限内で特定のロールに割り当てられたメンバーの詳細を取得します。ユーザーのアクセス権を監査および管理するのに役立ちます。

テーブル固有の情報

Select

Note:RoleAssignmentMember を返すにはPrincipalId が必要です。

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 ロールが割り当てられたメンバーの一意の数値識別子。特定のロールの割り当てを追跡するのに役立ちます。
Updated Datetime ロールの割り当てが最後に変更された日時。権限とアクセス制御の変更を追跡するのに役立ちます。
IsHiddenInUI Boolean 割り当てられたロールのメンバーがユーザーインターフェースで非表示かどうかを示します。表示されるべきでないバックグラウンドのロールを管理するのに役立ちます。
LoginName String ロールに割り当てられたユーザーまたはグループのログイン名。認証と権限の管理に役立ちます。
Title String ロールが割り当てられたメンバーの表示タイトル。割り当てられたユーザーやグループを簡単に識別するのに役立ちます。
PrincipalType Int ロールに割り当てられたプリンシパルの種類を指定します。有効な値は次のとおりです:None (0)、User (1)、DistributionList (2)、SecurityGroup (4)、SharePointGroup (8)、All (15)。異なる種類のロールメンバーを分類するのに役立ちます。
AllowMembersEditMembership Boolean ロールのメンバーがグループのメンバーシップを変更できるかどうかを示します。自己管理型のロールに役立ちます。
AllowRequestToJoinLeave Boolean ユーザーが割り当てられたロールに参加または離脱を要求できるかどうかを示します。ロールのアクセス制御に役立ちます。
AutoAcceptRequestToJoinLeave Boolean ロールへの参加または離脱のリクエストが自動的に承認されるかどうかを示します。オープンアクセスのロールに役立ちます。
Description String ロールに割り当てられたメンバーの簡単な説明。ロールの責任に関する追加のコンテキストを提供するのに役立ちます。
OnlyAllowMembersViewMembership Boolean ロールのメンバーのみがそのメンバーシップの詳細を閲覧できるかどうかを示します。プライバシー設定を強化するのに役立ちます。
OwnerTitle String 割り当てられたロールの所有者の表示名。Useful for identifying role managers or administrators.ロールマネージャや管理者を識別するのに便利です。
RequestToJoinLeaveEmailSetting String ロールのメンバーシップリクエストが送信されるE メールアドレス。アクセスリクエストの管理に役立ちます。
List String

Lists.Title

ロール割り当て情報が取得されるSharePoint リストの表示名。ロール割り当てのコンテキストを識別するのに役立ちます。
ItemId Int ロール割り当てに関連するリストアイテムの一意の識別子。ロール割り当てを特定のアイテムにリンクするのに役立ちます。
PrincipalId Int

RoleAssignments.PrincipalId

ロールに割り当てられたプリンシパル(ユーザーまたはグループ)の一意の識別子。セキュリティとアクセス制御の管理に役立ちます。

CData Cloud

RoleAssignments

アクセス権を持つユーザーやグループなど、SharePoint サイトで設定されたロールの割り当てを取得します。SharePoint のセキュリティポリシーを確認および管理するのに役立ちます。

テーブル固有の情報

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 ロール割り当ての一意の識別子。SharePoint での権限の追跡と管理に役立ちます。
PrincipalId Int ロールに割り当てられたプリンシパル(ユーザーまたはグループ)の一意の識別子。アクセス制御とセキュリティ設定の管理に役立ちます。
Updated Datetime ロールの割り当てが最後に変更された日時。権限変更の監査に役立ちます。
List String

Lists.Title

ロール割り当てを含むSharePoint リストの表示名。ロールが適用される場所を識別するのに役立ちます。
ItemId Int ロール割り当てに関連するリストアイテムの一意の識別子。ロール割り当てを特定のレコードにリンクするのに役立ちます。

CData Cloud

RoleDefinitionBindings

SharePoint サイト内の特定のセキュリティグループやユーザーにバインドされたロール定義を一覧表示します。管理者が権限ポリシーを施行するのに役立ちます。

テーブル固有の情報

Select

NOTE:RoleDefinitionBindings を返すにはPrincipalId が必要です。

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

ロールに割り当てられたプリンシパル(ユーザーまたはグループ)の一意の識別子。セキュリティとアクセス制御の設定を管理するのに役立ちます。
ID [KEY] Int ロール割り当てメンバーの一意の識別子。SharePoint でのロール割り当ての追跡に役立ちます。
BasePermissions_High Long ロールに適用される高レベルの基本権限を表します。アクセス権とセキュリティポリシーを定義するのに役立ちます。
BasePermissions_Low Long ロールに割り当てられた低レベルの基本権限を表します。セキュリティ設定の管理に使用されます。
Description String ロール定義の簡単な説明。割り当てられたロールの目的とスコープを理解するのに役立ちます。
Hidden Boolean ロール定義がユーザーインターフェースで非表示かどうかを示します。システムレベルのロールを管理するのに便利です。
Name String ロール定義の表示名。ユーザーがロールとその権限を識別するのに役立ちます。
Order Int ロール定義の割り当て順位。ロール申請の優先順位付けに便利です。
RoleTypeKind Int 割り当てられたロールの種類を指定します。SharePoint 内の異なるロール定義を分類するのに役立ちます。
List String

Lists.Title

ロール割り当てを含むSharePoint リストの表示名。ロールが適用される場所を識別するのに役立ちます。
ItemId Int ロール定義に関連するリストアイテムの一意の識別子。ロール定義を特定のレコードにリンクするのに役立ちます。

CData Cloud

Roles

SharePoint サイトコレクション内の権限レベルを含む、使用可能なロール定義の詳細を提供します。セキュリティロールの設定および変更に不可欠です。

Columns

Name Type References Description
Id [KEY] Int ロール定義の一意の識別子。SharePoint でロールの権限を追跡および管理するのに役立ちます。
BasePermissions_High Long ロール定義に割り当てられた高レベルの基本権限を表します。SharePoint 内で広範なアクセス権を定義するのに役立ちます。
BasePermissions_Low Long ロール定義に割り当てられた低レベルの基本権限を表します。詳細なアクセス制御を設定するために使用されます。
Description String ロール定義の簡単な概要。目的と割り当てられた権限を説明します。ロールのスコープを理解するのに役立ちます。
Hidden Bool ロール定義が権限レベルページで非表示になっているかどうかを示します。システム定義またはバックグラウンドロールの管理に便利です。
Name String ロール定義に割り当てられた表示名。ユーザーが異なる権限レベルを簡単に識別するのに役立ちます。
Order Int サイトコレクション内の権限レベルリストにおけるロール定義の位置を決定します。ロールを構造的に整理するのに便利です。
RoleTypeKind Int SP.RoleType 列挙型にマッピングされたロール定義のタイプを表します。SharePoint 内で定義済みのカテゴリに基づいてロールを分類するのに役立ちます。

CData Cloud

Sites

SharePoint サーバー内で利用可能なすべてのサイトのリストをメタデータとサイトの詳細を含めて取得します。大規模なSharePoint 環境の管理とナビゲーションに役立ちます。

Columns

Name Type References Description
SiteURL [KEY] String SharePoint サイトの完全なURL。自動化やAPI でのサイトのナビゲーションと参照に役立ちます。
SiteCollectionId String サイトコレクションの一意識別子。SharePoint 環境内でサイトコレクションを区別するのに役立ちます。
WebId String サイトコレクション内の特定のサイトの一意識別子。個別のサブサイトを参照するのに役立ちます。
Title String サイトの表示タイトル。ユーザーがコレクション内のサイトを簡単に識別するのに役立ちます。
SiteCollectionURL String サイトを含むサイトコレクションのURL。親サイトコレクションを識別するのに役立ちます。
Description String サイトの目的やコンテンツの概要を示す簡単な説明。ユーザーにコンテキストを提供するのに役立ちます。
Created Datetime サイトが作成された日時。サイトの存続期間と履歴記録を追跡するのに役立ちます。
LastModified Datetime サイトが最後に更新された日時。最近のサイトアクティビティを監視するのに役立ちます。
SPWebUrl String ブラウザでサイトを表示するために使用されるURL。UI ナビゲーションと直接リンクに役立ちます。
Author String サイトを作成したユーザー。サイトの所有権と管理責任を追跡するのに役立ちます。
DocumentSignature String サイトのドキュメント署名に関連する一意識別子。セキュリティと検証の目的に役立ちます。
FileExtension String サイトのプライマリドキュメントに関連付けられたファイル拡張子タイプ。サイト関連のファイルを識別するのに役立ちます。
SecondaryFileExtension String サイトのファイルに関連付けられた代替ファイル拡張子。追加のドキュメント分類に役立ちます。
FileType String サイトに関連付けられたファイルのタイプ。サイト関連のドキュメントを整理およびフィルタ処理するのに役立ちます。
DocId Long 特定の地理的場所内のサイトの一意識別子。複数地域のSharePoint 環境に役立ちます。
GeoLocationSource String サイトの地理的場所。地域または物理的な場所に基づいてサイトを分類するのに役立ちます。
HitHighlightedSummary String サイトのコンテンツのハイライトされた概要。検索インデックス作成とクイックコンテンツプレビューに役立ちます。
Importance Long サイトに割り当てられた重要度スコア。検索結果または組織階層内でサイトに優先順位を付けるのに役立ちます。
IsContainer Bool サイトがフォルダとして構造化されているかどうかを示します。フォルダベースのサイトとドキュメントベースのサイトを区別するのに役立ちます。
IsDocument Bool サイトがドキュメントとして扱われるかどうかを示します。サイトタイプを分類するのに役立ちます。
Path String SharePoint 内の完全なサイトパス。ファイル参照とフォルダナビゲーションの構築に役立ちます。
Rank Double さまざまなパラメータに基づいてサイトに割り当てられたランク。検索の関連性を判断するのに役立ちます。
RenderTemplateId String サイトの表示に使用されるコントロールレンダリングテンプレート。UI カスタマイズとテーマ設定に役立ちます。
SiteLogo String サイトのロゴのURI。ブランディングと視覚的な識別に役立ちます。
ViewsLifeTime Long サイトが作成されてから受け取ったビューの総数。長期的なエンゲージメントを測定するのに役立ちます。
ViewsRecent Long 過去14日間にサイトが受け取ったビューの総数。最近のユーザーの関心を追跡するのに役立ちます。
WebTemplate String サイトの作成に使用されたWeb テンプレート。サイトの構造と目的を識別するのに役立ちます。

CData Cloud

Subsites

指定されたSharePoint サイト配下のすべてのサブサイトを階層とメタデータを含めて一覧表示します。SharePoint 環境内でのコンテンツの構造化と整理に役立ちます。

Columns

Name Type References Description
Id [KEY] String サブサイトの一意のGUID(SP.Web.Id)。
Title String ナビゲーションとUI に表示されるサブサイトの表示タイトル。
Url String サブサイトの絶対URL(例: https://tenant.sharepoint.com/sites/parent/subsite)。
AccessRequestSiteDescription String このサイトのアクセス要求ページに表示されるオプションのテキスト。
Acronym String 特定のエクスペリエンスでサイトに使用される短縮名または頭字語。
AllowAutomaticASPXPageIndexing Bool 従来の.aspx ページを検索インデックスに自動的に追加できるかどうか。
AllowCreateDeclarativeWorkflowForCurrentUser Bool 現在のユーザーが宣言型(ノーコード)ワークフローを作成できるかどうか。
AllowDesignerForCurrentUser Bool 現在のユーザーがSharePoint Designer でサイトを開くことができるかどうか。
AllowMasterPageEditingForCurrentUser Bool 現在のユーザーがこのサイトのマスターページを編集できるかどうか。
AllowRevertFromTemplateForCurrentUser Bool 現在のユーザーがテンプレートから適用されたサイトの変更を元に戻すことができるかどうか。
AllowRssFeeds Bool サイトレベルでRSS フィードを有効または無効にします。
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Bool 現在のユーザーが宣言型ワークフローをテンプレートとして保存できるかどうか。
AllowSavePublishDeclarativeWorkflowForCurrentUser Bool 現在のユーザーが宣言型ワークフローを保存および公開できるかどうか。
AlternateCssUrl String 従来のページ用の代替CSS ファイルURL(構成されている場合)。
AppInstanceId String サイトに関連付けられたアプリインスタンスGUID(アプリからプロビジョニングされた場合)。
ClassicWelcomePage String クラシックエクスペリエンスで使用されるウェルカムページのパス。
CommentsOnSitePagesDisabled Bool このサイトのモダンページコメントを有効または無効にします。
Configuration Int 数値テンプレート構成(サイト定義構成ID)。
ContainsConfidentialInfo Bool サイトに機密情報が含まれている可能性があることを示します。
Created Datetime サブサイトの作成タイムスタンプ。
CurrentChangeToken_StringValue String このWeb に対してキャプチャされた最新の変更を識別する変更トークン文字列。
CustomMasterUrl String サイトに適用されたカスタムマスターページURL(クラシック)。
CustomSiteActionsDisabled Bool true の場合、UI でカスタムサイトアクションを無効にします。
DefaultNewPageTemplateId String 新しいモダンページを作成するときに使用される既定のページテンプレートID。
Description String 一部のディレクトリとUI のコンテキストに表示されるサイトの説明。
DescriptionForExistingLanguage String 現在のUI 言語のローカライズされた説明。
DesignerDownloadUrlForCurrentUser String 現在のユーザーがSharePoint Designer を利用できる場合のダウンロードURL。
DesignPackageId String このサイトに適用されたデザインパッケージ(WSP)識別子(従来)。
DisableAppViews Bool true の場合、サイト内のアプリケーション固有のビューを無効にします。
DisableFlows Bool true の場合、このサイトのPower Automate(Flow)統合を無効にします。
DisableRecommendedItems Bool このサイトの推奨コンテンツエクスペリエンスをオフにします。
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Bool ライブラリの吹き出しでOffice Web Apps ドキュメントプレビューアーを無効にします。
EffectiveBasePermissions_High Long サイトに対する現在のユーザーの有効な権限マスクの上位32ビット。
EffectiveBasePermissions_Low Long サイトに対する現在のユーザーの有効な権限マスクの下位32ビット。
EnableMinimalDownload Bool クラシックページの最小ダウンロード方法(MDS)を有効にします。
ExcludeFromOfflineClient Bool サイトコンテンツをオフラインクライアントで使用できないようにします。
FontOptionForSiteFooterNav_fontFace String フッターナビゲーションに適用されるフォントフェイス(モダンテーマ設定)。
FontOptionForSiteFooterNav_fontFamilyKey String フッターナビゲーションに使用されるフォントファミリーキー(モダン)。
FontOptionForSiteFooterNav_fontVariantWeight String フッターナビゲーションフォントに使用されるバリアントまたはウェイト(モダン)。
FontOptionForSiteFooterTitle_fontFace String フッタータイトルに適用されるフォントフェイス(モダンテーマ設定)。
FontOptionForSiteFooterTitle_fontFamilyKey String フッタータイトルに使用されるフォントファミリーキー(モダン)。
FontOptionForSiteFooterTitle_fontVariantWeight String フッタータイトルフォントに使用されるバリアントまたはウェイト(モダン)。
FontOptionForSiteNav_fontFace String サイトのトップナビゲーションに適用されるフォントフェイス(モダン)。
FontOptionForSiteNav_fontFamilyKey String サイトナビゲーションに使用されるフォントファミリーキー(モダン)。
FontOptionForSiteNav_fontVariantWeight String サイトナビゲーションフォントに使用されるバリアントまたはウェイト(モダン)。
FontOptionForSiteTitle_fontFace String サイトタイトルに適用されるフォントフェイス(モダンヘッダー)。
FontOptionForSiteTitle_fontFamilyKey String サイトタイトルに使用されるフォントファミリーキー(モダン)。
FontOptionForSiteTitle_fontVariantWeight String サイトタイトルフォントに使用されるバリアントまたはウェイト(モダン)。
FooterAlignment Int モダンサイトフッターの配置設定。
FooterBlur Int モダンフッター背景のぼかし強度(使用する場合)。
FooterColorIndexInDarkMode Int ダークモードでフッターに適用されるテーマカラーインデックス。
FooterColorIndexInLightMode Int ライトモードでフッターに適用されるテーマカラーインデックス。
FooterEmphasis Int モダンフッターで使用される強調レベル(ウェイト)。
FooterEnabled Bool サイトでモダンフッターを有効にします。
FooterLayout Int モダンフッターで使用されるレイアウトオプション。
FooterOverlayColor Int フッター背景に適用されるオーバーレイカラーインデックス。
FooterOverlayGradientDirection Int フッターオーバーレイで使用されるグラデーション方向。
FooterOverlayOpacity Int フッターオーバーレイレイヤーの不透明度。
HasWebTemplateExtension Bool Web テンプレート拡張機能が存在するかどうかを示します。
HeaderColorIndexInDarkMode Int ダークモードでヘッダーに適用されるテーマカラーインデックス。
HeaderColorIndexInLightMode Int ライトモードでヘッダーに適用されるテーマカラーインデックス。
HeaderEmphasis Int モダンヘッダーで使用される強調レベル(ウェイト)。
HeaderLayout Int モダンヘッダーで使用されるレイアウトオプション。
HeaderOverlayColor Int ヘッダー背景に適用されるオーバーレイカラーインデックス。
HeaderOverlayGradientDirection Int ヘッダーオーバーレイで使用されるグラデーション方向。
HeaderOverlayOpacity Int ヘッダーオーバーレイレイヤーの不透明度。
HideTitleInHeader Bool true の場合、モダンヘッダーのサイトタイトルを非表示にします。
HorizontalQuickLaunch Bool 水平クイック起動ナビゲーションレイアウトを使用します(クラシック)。
IsEduClass Bool サイトがEDU クラスエクスペリエンスに関連付けられていることを示します。
IsEduClassProvisionChecked Bool EDU クラスプロビジョニングチェックが完了したかどうかをマークします。
IsEduClassProvisionPending Bool EDU クラスプロビジョニングが保留中であることを示します。
IsHomepageModernized Bool サイトのホームページがモダン化されたかどうかを示します。
IsMultilingual Bool サイトで多言語UI(MUI)が有効になっているかどうか。
IsProvisioningComplete Bool サイトプロビジョニングプロセスが完了したことを示します。
IsRevertHomepageLinkHidden Bool モダン化されたサイトの「ホームページを元に戻す」リンクを非表示にします。
Language Int サイトの既定のUI 言語のLCID(例:1033=en-US)。
LastItemModifiedDate Datetime サイト内での最新のアイテム変更のタイムスタンプ。
LastItemUserModifiedDate Datetime ユーザーによって開始された最新のアイテム変更のタイムスタンプ。
LogoAlignment Int モダンヘッダー内のサイトロゴの配置オプション。
MasterUrl String サイトで使用されるマスターページURL(従来のマスターページ)。
MegaMenuEnabled Bool モダンメガメニュースタイルのナビゲーションを有効にします(サポートされている場合)。
MembersCanShare Bool true の場合、メンバーが他のユーザーとコンテンツを共有できるようにします。
NavAudienceTargetingEnabled Bool サイトナビゲーションリンクの対象ユーザーターゲット設定を有効にします。
NextStepsFirstRunEnabled Bool サイト所有者に「次のステップ」初回実行エクスペリエンスを表示します。
NoCrawl Bool true の場合、サイトは検索インデックスと結果から除外されます。
NotificationsInOneDriveForBusinessEnabled Bool このサイトに関連するOneDrive for Business 通知を有効にします。
NotificationsInSharePointEnabled Bool サイトアクティビティのSharePoint 通知を有効にします。
ObjectCacheEnabled Bool クラシックの発行シナリオのオブジェクトキャッシュを有効にします。
OverwriteTranslationsOnChange Bool 既定のテキストが変更されたときに代替言語の翻訳を上書きします。
PreviewFeaturesEnabled Bool このサイトでプレビューまたは早期リリース機能を有効にします(テナント制御)。
PrimaryColor String 現在のテーマによって適用されるプライマリブランドカラーの値。
QuickLaunchEnabled Bool 左側(クイック起動)ナビゲーションを有効にします。
RecycleBinEnabled Bool このサイトでごみ箱機能が有効になっているかどうか。
RelatedHubSiteIds String このサイトに関連または関連付けられているハブサイトID のリスト。
ResourcePath_DecodedUrl String サイトを表すリソースパスのデコードされたURL 値。
SaveSiteAsTemplateEnabled Bool true の場合、サイトをテンプレートとして保存できます(クラシックの機能)。
SearchBoxInNavBar Int ナビゲーションバーの検索ボックスの配置または表示オプション。
SearchBoxPlaceholderText String ナビゲーション検索ボックスに表示されるカスタムプレースホルダーテキスト。
SearchScope Int このサイトのUI から検索するときに使用される既定のスコープ。
ServerRelativePath_DecodedUrl String サイトのデコードされたサーバー相対パス(モダン型パス)。
ServerRelativeUrl String サイトのサーバー相対URL(例: /sites/parent/subsite)。
ShowUrlStructureForCurrentUser Bool 現在のユーザーがUI でURL またはフォルダ構造を表示できるようにします。
SiteLogoDescription String サイトロゴの代替テキストまたは説明。
SiteLogoUrl String サイトロゴ画像のURL。
SupportedUILanguageIds String サイトのUI(MUI)で有効になっている言語のLCID のコレクション。
SyndicationEnabled Bool true の場合、サイトのRSS 配信を有効にします。
TenantAdminMembersCanShare Int メンバーが共有できるかどうかを制御するテナントポリシー値。
TenantTagPolicyEnabled Bool このサイトにテナントタグポリシーが適用されているかどうかを示します。
ThemeApplicationActionHistory String サイトでのテーマ適用アクションの履歴ログ。
ThemeData String サイトに適用されたシリアル化されたテーマデータ。
ThemedCssFolderUrl String サイトのテーマ設定されたCSS が格納されているフォルダURL。
ThirdPartyMdmEnabled Bool サードパーティのモバイルデバイス管理統合を有効にします。
TitleForExistingLanguage String 現在のUI 言語のローカライズされたタイトル。
TreeViewEnabled Bool true の場合、ナビゲーションのツリービュー(従来)を表示します。
UIVersion Int UI バージョン番号(従来のUI バージョン設定)。
UIVersionConfigurationEnabled Bool true の場合、従来のUI バージョンの構成を許可します。
WebTemplate String サイトのプロビジョニングに使用されたテンプレート名(例: STS)。
WebTemplateConfiguration String WebTemplate と組み合わされたテンプレート構成値(サイト定義構成ID)。
WebTemplatesGalleryFirstRunEnabled Bool true の場合、Web テンプレートギャラリーの初回実行エクスペリエンスを表示します。
WelcomePage String ウェルカムページまたはホームページの相対URL(従来のエクスペリエンス)。
AccessRequestListUrl String このサイトのアクセス要求を格納するリストのURL。
RequestAccessEmail String アクセス要求を受信するために使用されるメールアドレス。
UseAccessRequestDefault Bool true の場合、既定のアクセス要求動作を使用します。
DescriptionTranslations String サイトの説明のローカライズされたリソースエントリ。
TitleTranslations String サイトタイトルのローカライズされたリソースエントリ。

CData Cloud

Users

SharePoint サイトまたはグループ内のユーザーとその割り当てられたロールのリストを取得します。権限の管理とユーザー活動の追跡に重要です。

テーブル固有の情報

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 SharePoint 環境内の各ユーザーに割り当てられた一意の数値識別子。ワークフローや権限管理でユーザーを参照するのに役立ちます。
LoginName String SharePoint にアクセスするユーザーの一意のログイン名。システム内でユーザーを認証し識別するのに役立ちます。
Title String ユーザーに関連付けられた表示名またはタイトル。SharePoint のインターフェースでユーザーフレンドリーな名前を表示するのに便利です。
IsHiddenInUI Bool ユーザーがSharePoint ユーザーインターフェースで非表示になっているかどうかを示します。バックグラウンドアカウントやシステムアカウントの管理に便利です。
GroupId Int ユーザーが所属するグループの識別子。グループ内のユーザーのロールと権限の管理に役立ちます。
AadObjectId_NameId String ユーザー固有の識別子を表すAzure Active Directory(AAD)オブジェクトID。SharePoint をAzure AD と統合する際に便利です。
AadObjectId_NameIdIssuer String ユーザーのAAD NameId の発行者。認証元を検証するのに役立ちます。
Email String ユーザーに関連付けられているプライマリE メールアドレス。通信や通知の目的で役立ちます。
EmailWithFallback String プライマリE メールアドレスが利用できない場合の、ユーザーの代替または予備のE メールアドレス。通信の冗長性を確保するのに役立ちます。
Expiration String 該当する場合、ユーザーのアクセスの有効期限を指定します。一時的なアクセス権限を管理するのに役立ちます。
HexCid String ユーザーのクライアントID の16進数表現。システムの追跡および認証プロセスに役立ちます。
IsEmailAuthenticationGuestUser Bool ユーザーがE メールで認証されたゲストかどうかを示します。外部ユーザーを識別するのに役立ちます。
IsShareByEmailGuestUser Bool ユーザーが共有目的でE メールで招待されたゲストかどうかを示します。外部の共同作業者を追跡するのに役立ちます。
IsSiteAdmin Bool ユーザーがSharePoint サイトコレクションの管理者権限を持っているかどうかを示します。サイトの所有権とセキュリティの管理に役立ちます。
UserId_NameId String SharePoint のユーザーID システムにおけるユーザーの一意の識別子。ユーザーのアクティビティと権限を追跡するのに役立ちます。
UserId_NameIdIssuer String SharePoint のユーザーID システムにおけるユーザーID の発行者。ID ソースの検証に役立ちます。
UserPrincipalName String ユーザーのユーザープリンシパル名(UPN)で、通常はE メール形式です。認証とユーザー識別に役立ちます。
PrincipalType Int ビット単位の値を使用してプリンシパルの種類を定義します: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 リストアイテムにファイルを添付します。SharePoint レコードに補足ドキュメントを追加する際に便利です。
AddImage SharePoint リストアイテムに画像をアップロードします。SharePoint レコードにビジュアルコンテンツを埋め込むために不可欠です。
AddList 指定されたプロパティで新しいSharePoint リストを作成します。構造化データストレージのためのリスト作成を自動化するのに役立ちます。
AddListColumn 既存のSharePoint リストに新しい列を追加します。リスト構造を動的に変更するのに役立ちます。
AddPage 指定されたSharePoint ページライブラリ内に新しいページを作成します。
AddRoleAssignment SharePoint リストまたはリストアイテム内の指定されたユーザーまたはグループに新しいロールを割り当てます。アクセス許可とアクセスを細かく調整するために重要です。
AddUserToGroup 指定されたSharePoint グループにユーザーを追加して、アクセスとアクセス許可を管理します。
BreakRoleInheritance SharePoint リストまたはアイテムから継承されたアクセス許可を削除し、親のアクセス許可から独立させます。より細かいレベルでアクセスを制限またはカスタマイズするのに役立ちます。
CheckInDocument 以前にチェックアウトされたドキュメントをチェックインし、他のユーザーが編集できるようにします。ドキュメントのバージョン管理を維持し、不要なファイルロックを防ぐのに役立ちます。
CheckOutDocument SharePoint ライブラリからドキュメントをチェックアウトし、チェックインされるまで他のユーザーが変更できないようにします。複数のユーザーがファイルを編集する際の競合を回避するのに役立ちます。
CheckPermissions SharePoint リストまたはリストアイテムに対する指定されたユーザーまたはグループの有効なアクセス許可を確認します。
CopyDocument SharePoint ドキュメントライブラリ内のある場所から別の場所にファイルをコピーします。コンテンツの複製とバックアッププロセスを容易にします。
CopyFolderJob SharePoint フォルダ(およびそのコンテンツ)を対象の場所に複製する非同期コピージョブを開始します。サイト間転送、バージョン履歴オプション、および競合解決動作をサポートします。
CreateFolder 指定されたSharePoint ドキュメントライブラリに新しいフォルダを作成します。構造化された階層内でファイルを整理するのに役立ちます。
DeleteAttachment SharePoint リストアイテムから添付ファイルを削除します。ファイルストレージを管理し、リストを整理された状態に保つのに役立ちます。
DeleteDocument SharePoint ドキュメントライブラリからドキュメントを削除します。コンテンツのクリーンアップとドキュメントライフサイクルの管理に役立ちます。
DeleteList サイトからSharePoint リストを完全に削除します。古くなった、または使用されていないリストを廃止する際に役立ちます。
DeleteListColumn 既存のSharePoint リストから列を削除します。リストの再構築や不要なフィールドの削除に役立ちます。
DiscardCheckOutDocument ドキュメントのチェックアウトをキャンセルし、チェックアウト中に行われたすべての変更を破棄します。意図しない変更を防ぐのに役立ちます。
GetAdminConsentURL 管理者がアプリケーションへのアクセスを許可するために開く必要がある管理者の同意URL を生成します。SharePoint でOAuth 認証を構成するために不可欠です。
GetCurrentUser 現在ログインしているSharePoint ユーザーの詳細を取得します。ユーザーエクスペリエンスのパーソナライズとロールベースのアクセス制御の実施に役立ちます。
GetJobStatus 非同期SharePoint コピー / 移動ジョブの進行状況をポーリングし、現在の状態、エラー、および関連するステータスメッセージを返します。
MoveAttachmentOrDocument SharePoint 内のあるフォルダから別のフォルダに添付ファイルまたはドキュメントを移動します。ドキュメントライブラリ内のコンテンツを再編成するのに役立ちます。
MoveFolderJob SharePoint フォルダ(およびそのコンテンツ)を対象の場所に再配置する非同期移動ジョブを開始します。サイト間転送、バージョン履歴オプション、および競合解決動作をサポートします。
RemoveRoleAssignment SharePoint リストまたはリストアイテムから特定のロール割り当てを削除します。アクセスが不要になった場合にアクセス許可を取り消すのに役立ちます。
RemoveUserFromGroup 指定されたSharePoint グループからユーザーを削除します。ユーザーのロールが変更された場合にアクセスを取り消すのに役立ちます。
RenameAttachmentOrDocument SharePoint ライブラリ内の添付ファイルまたはドキュメントの名前を変更します。コンテンツに影響を与えずにファイル名を更新するのに役立ちます。

CData Cloud

AddAttachment

SharePoint リストアイテムにファイルを添付します。SharePoint レコードに補足ドキュメントを追加する際に便利です。

Input

Name Type Required Description
ListTitle String True 添付ファイルを追加するアイテムを含むSharePoint リストのタイトル。対象リストを識別するために使用されます。
ItemId String True ファイルが添付されるリストアイテムの一意識別子。添付ファイルが正しいアイテムにリンクされることを確実にします。
FileName String True 添付ファイルとして追加されるファイルの名前。添付ファイルの追跡と管理に役立ちます。
InputFilePath String False アップロードする添付ファイルの完全なファイルパス。ファイルコンテンツを直接提供しない場合に必要です。

Result Set Columns

Name Type Description
Success Boolean 添付ファイルのアップロード操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
RelativeUrl String アップロードされた添付ファイルのサーバー相対URL。添付ファイルへのアクセスと参照に便利です。

CData Cloud

AddImage

SharePoint リストアイテムに画像をアップロードします。SharePoint レコードにビジュアルコンテンツを埋め込むために不可欠です。

Input

Name Type Required Description
ListName String True 画像が追加されるSharePoint リストの表示名。対象リストを識別するために使用されます。
ItemId String True 画像が添付されるリストアイテムの一意識別子。画像が正しいアイテムにリンクされることを確実にします。
ColumnInternalName String True 画像が格納される列の内部名。リストスキーマ内の正しいフィールドを識別するために役立ちます。
FileName String True アップロードされる画像ファイルの名前。添付画像の追跡と管理に役立ちます。
InputFilePath String False アップロードする画像の完全なファイルパス。画像コンテンツを直接提供しない場合に必要です。

Result Set Columns

Name Type Description
Success Boolean 画像アップロード操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
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 リスト作成操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。リスト作成の問題の診断に役立ちます。

CData Cloud

AddListColumn

既存のSharePoint リストに新しい列を追加します。リスト構造を動的に変更するのに役立ちます。

Input

Name Type Required Description
ListName String True 新しい列が追加されるSharePoint リストの表示名。対象リストを識別するために使用されます。
ColumnDisplayName String True 追加される列の表示名。SharePoint UI で列を表示するために使用されます。
ColumnType String True 新しい列のデータ型。有効なオプションはSharePoint のFieldTypes で定義されており、Text、Number、DateTime、Lookup などがあります。詳細については https://docs.microsoft.com/ja-jp/previous-versions/office/sharepoint-csom/ee540543(v=office.15) を参照してください。
ColumnInternalName String False 列の内部システム名。プログラムによる参照に使用され、作成後に変更することはできません。
IsRequired Boolean False 列がデータ入力に必須かどうかを示します。true の場合、ユーザーはアイテムを追加または編集する際に値を入力する必要があります。
EnforceUniqueValues Boolean False 列が一意の値を強制するかどうかを示します。重複エントリを防ぐのに役立ちます。
DisplayAfterCreation Boolean False 新しく追加された列をSharePoint UI ですぐに表示するかどうかを示します。デフォルトはtrue です。
LookupListId String False 列がルックアップフィールドの場合、対象データを含むリストのID を指定します。
LookupFieldName String False 列がルックアップフィールドの場合、対象リストで参照されるフィールドの表示名を指定します。

Result Set Columns

Name Type Description
Success Boolean 列作成操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。列作成の問題の診断に役立ちます。

CData Cloud

AddPage

指定されたSharePoint ページライブラリ内に新しいページを作成します。

ストアドプロシージャ固有の情報

作成されたページはデフォルトでは空で未公開です。

例


EXECUTE AddPage Title = 'My New Page';
EXECUTE AddPage PageLibrary = 'Page Library', Title = 'Welcome Page', Template = '1';

Input

Name Type Required Description
PageLibrary String False ファイルが保存されているSharePoint ドキュメントライブラリのタイトル。一般的なデフォルトは「Site Pages」です。

デフォルト値はSite Pagesです。

Title String True 作成する新しいページの名前またはタイトル。これはファイル名として使用されます(例:PageTitle.aspx)。
Template String False ページ作成時に使用するテンプレートの種類。Values:0 = StandardPage, 1 = WikiPage, 2 = FormPage.

使用できる値は次のとおりです。0, 1, 2

デフォルト値は0です。

Result Set Columns

Name Type Description
Success Boolean ページの作成操作が成功したかどうかを示します。ページの作成に成功した場合は「true」を返します。
RelativeUrl String 新しく作成されたSharePoint ページのサーバー相対URL(例:/sites/demo/SitePages/PageTitle.aspx)。

CData Cloud

AddRoleAssignment

SharePoint リストまたはリストアイテム内の指定されたユーザーまたはグループに新しいロールを割り当てます。アクセス許可とアクセスを細かく調整するために重要です。

Input

Name Type Required Description
RoleId Int True 割り当てられるアクセス許可を指定するロール定義の一意のID。付与されるアクセスレベルを決定します。
PrincipalId Int True 割り当てられたロールを受け取るユーザーまたはグループの一意のID。アクセス許可が誰に適用されるかを識別するのに役立ちます。
List String True ロールの割り当てが適用されるSharePoint リストの内部名。リストレベルでアクセス許可を管理するのに役立ちます。
ItemId Int False ロールの割り当てが適用されるリストアイテムの一意識別子。アイテムレベルでアクセス許可を管理するのに役立ちます。

Result Set Columns

Name Type Description
Success Boolean ロール割り当て操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。アクセス許可割り当ての問題の診断に役立ちます。

CData Cloud

AddUserToGroup

指定されたSharePoint グループにユーザーを追加して、アクセスとアクセス許可を管理します。

Input

Name Type Required Description
LoginName String True SharePoint グループに追加されるユーザーのログイン名。
Group String True ユーザーが追加されるSharePoint グループの名前。例:'Project Managers' または'Site Admins'。

Result Set Columns

Name Type Description
Success Boolean グループへのユーザー追加操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

BreakRoleInheritance

SharePoint リストまたはアイテムから継承されたアクセス許可を削除し、親のアクセス許可から独立させます。より細かいレベルでアクセスを制限またはカスタマイズするのに役立ちます。

Input

Name Type Required Description
List String True セキュリティの継承が解除されるSharePoint リストの内部名。リストまたはそのアイテムに固有のアクセス許可を適用するのに役立ちます。
ItemId Int False セキュリティの継承が解除されるリストアイテムの一意識別子。アイテムレベルのアクセス許可を設定するのに役立ちます。
CopyRoleAssignments Boolean False 既存のロール割り当てを親オブジェクトからコピーするかどうかを示します。'true' の場合、現在のアクセス許可が保持されます。'false' の場合、すべてのアクセス許可が削除され、再割り当てする必要があります。

デフォルト値はtrueです。

Result Set Columns

Name Type Description
Success Boolean ロール継承の解除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。セキュリティとアクセス許可の問題の診断に役立ちます。

CData Cloud

CheckInDocument

以前にチェックアウトされたドキュメントをチェックインし、他のユーザーが編集できるようにします。ドキュメントのバージョン管理を維持し、不要なファイルロックを防ぐのに役立ちます。

Input

Name Type Required Description
RelativeURL String True ドキュメントを含むフォルダのサーバー相対URL。SharePoint サイト内のドキュメントを検索するのに役立ちます。
DocumentName String True チェックインするファイルの名前。正しいドキュメントが処理されることを保証します。
Comment String False チェックイン時に提供されるオプションのメッセージ。変更内容の説明やバージョン履歴の詳細を提供するのに役立ちます。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのチェックイン操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

CheckOutDocument

SharePoint ライブラリからドキュメントをチェックアウトし、チェックインされるまで他のユーザーが変更できないようにします。複数のユーザーがファイルを編集する際の競合を回避するのに役立ちます。

Input

Name Type Required Description
RelativeURL String True ドキュメントを含むフォルダのサーバー相対URL。SharePoint サイト内のドキュメントを検索するのに役立ちます。
DocumentName String True チェックアウトするファイルの名前。編集のために正しいドキュメントがロックされることを保証します。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのチェックアウト操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

CheckPermissions

SharePoint リストまたはリストアイテムに対する指定されたユーザーまたはグループの有効なアクセス許可を確認します。

Input

Name Type Required Description
Principal String True ユーザーまたはグループのログイン名(例:'i:0#.f|membership|[email protected]' または'Group Name')。
ListName String True SharePoint リストのタイトル(例:'Documents')。
ItemId Int False アクセス許可を確認するリストアイテムのID。指定されていない場合、プロシージャはリストレベルでアクセス許可を確認します。

Result Set Columns

Name Type Description
Success Boolean Boolean フラグ:アクセス許可が正常に取得された場合はtrue、それ以外の場合はfalse。
BasePermissions_High Long 基本アクセス許可を表す上位32ビットマスク。
BasePermissions_Low Long 基本アクセス許可を表す下位32ビットマスク。

CData Cloud

CopyDocument

SharePoint ドキュメントライブラリ内のある場所から別の場所にファイルをコピーします。コンテンツの複製とバックアッププロセスを容易にします。

Input

Name Type Required Description
SourceFileRelativeUrl String True コピーされるソースファイルのサーバー相対URL。ドキュメントの元の場所を指定します。
DestFileRelativeUrl String True コピーされたファイルが配置されるサーバー相対URL。ドキュメントの新しい場所を定義します。

Result Set Columns

Name Type Description
Success Boolean ドキュメントのコピー操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

CopyFolderJob

SharePoint フォルダ(およびそのコンテンツ)を対象の場所に複製する非同期コピージョブを開始します。サイト間転送、バージョン履歴オプション、および競合解決動作をサポートします。

Input

Name Type Required Description
SourceFolderUrl String True コピーするフォルダのURL。絶対URL(https://domain.sharepoint.com/site/mysite/Shared%20Documents/SourceFolder)またはサイト相対URL(/Shared%20Documents/SourceFolder)を指定できます。ドキュメントライブラリ名を含める必要があります。
DestinationFolderUrl String True フォルダがコピーされる先のURL。絶対URL(https://domain.sharepoint.com/site/mysite/Target)またはサイト相対URL(/Target)を指定できます。親フォルダは既に存在している必要があります。
AllowSchemaMismatch Boolean False true の場合、ソースライブラリと宛先ライブラリのスキーマや列の構成が異なる場合でも、操作を続行できます。

デフォルト値はtrueです。

AllowSmallerVersionLimit Boolean False true の場合、宛先ライブラリのバージョン制限がソースよりも低い場合でもコンテンツの移動を許可しますが、バージョンが切り捨てられる可能性があります。

デフォルト値はtrueです。

IgnoreVersionHistory Boolean False true の場合、現在のバージョンのみがコピーされます。false の場合、コピー操作中にすべてのバージョン履歴が保持されます。

デフォルト値はtrueです。

NameConflictBehavior String False 同じ名前のアイテムが宛先に存在する場合の処理を制御します:FAIL(中止)、REPLACE(上書き)、またはRENAME(一意のサフィックスを追加)。

使用できる値は次のとおりです。FAIL, REPLACE, RENAME

デフォルト値はRENAMEです。

WaitJobToFinish Boolean False true の場合、コピージョブの完了を同期的に待機します。false の場合、非同期ステータスチェック用のジョブ追跡情報を使用して即座に戻ります。

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean コピー操作が正常に開始されたかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
JobId String このコピージョブを一意に識別するGUID。ステータス更新を取得するためにJob Progress をポーリングする際にこの値を使用します。
JobQueueUri String このジョブに関連付けられたAzure Storage Queue のURL。システムはステータス/進行状況メッセージをそこにエンキューします。
EncryptionKey String この特定のジョブのJobQueueUri 内のステータスメッセージを復号化するために使用されるBase64 エンコードされたAES キー。
ErrorMessage String 操作が失敗した場合にエラーの詳細が含まれます。それ以外の場合は空です。

CData Cloud

CreateFolder

指定されたSharePoint ドキュメントライブラリに新しいフォルダを作成します。構造化された階層内でファイルを整理するのに役立ちます。

Input

Name Type Required Description
RelativeURL String True 新しいフォルダが作成されるサーバー相対URL。新しいフォルダの親ディレクトリを定義します。
FolderName String True 作成される新しいフォルダの名前。SharePoint 内でファイルを識別および整理するのに役立ちます。
SiteURL String False フォルダを作成するSharePoint サイトのベースURL。指定された場合、この値は接続プロパティで指定されたデフォルトのサイトURL をオーバーライドします。

Result Set Columns

Name Type Description
Success Boolean フォルダ作成操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
Id String 新しく作成されたフォルダに割り当てられた一意識別子。後続の操作でフォルダを参照する際に役立ちます。

CData Cloud

DeleteAttachment

SharePoint リストアイテムから添付ファイルを削除します。ファイルストレージを管理し、リストを整理された状態に保つのに役立ちます。

Input

Name Type Required Description
ListTitle String True 添付ファイルが削除されるアイテムを含むSharePoint リストのタイトル。対象リストを識別するために使用されます。
ItemId String True 添付ファイルに関連付けられたリストアイテムの一意識別子。削除の対象として正しいアイテムが指定されることを保証します。
FileName String True 削除される添付ファイルの名前。リストアイテムから削除するファイルを指定するのに役立ちます。

Result Set Columns

Name Type Description
Success Boolean 添付ファイルの削除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

DeleteDocument

SharePoint ドキュメントライブラリからドキュメントを削除します。コンテンツのクリーンアップとドキュメントライフサイクルの管理に役立ちます。

Input

Name Type Required Description
RelativePath String True 削除されるドキュメントのサーバー相対パス。例:'/Shared Documents/My Folder/My Document.txt'。正確なファイルの場所を指定します。
Permanently String False ドキュメントを完全に削除するかどうかを示します。'true' に設定されている場合、ドキュメントは完全に削除されます。'false' の場合、復元の可能性のためにごみ箱に移動されます。

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean ドキュメントの削除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false'を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。ドキュメント削除の問題の診断に役立ちます。

CData Cloud

DeleteList

サイトからSharePoint リストを完全に削除します。古くなった、または使用されていないリストを廃止する際に役立ちます。

Input

Name Type Required Description
Name String True 削除されるSharePoint リストの名前。削除対象のリストを識別します。

Result Set Columns

Name Type Description
Success Boolean リストの削除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。リスト削除の問題の診断に役立ちます。

CData Cloud

DeleteListColumn

既存のSharePoint リストから列を削除します。リストの再構築や不要なフィールドの削除に役立ちます。

Input

Name Type Required Description
ListName String True 列が削除されるSharePoint リストの表示名。対象リストを識別します。
ColumnName String True 削除される列の表示名。リストから削除する正確なフィールドを指定します。

Result Set Columns

Name Type Description
Success Boolean 列の削除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャが失敗した場合、このフィールドに対応するエラーコードが表示されます。デバッグとトラブルシューティングに役立ちます。
ErrorMessage String プロシージャが失敗した場合、このフィールドに失敗の理由を説明する詳細なエラーメッセージが表示されます。列削除の問題の診断に役立ちます。

CData Cloud

DiscardCheckOutDocument

ドキュメントのチェックアウトをキャンセルし、チェックアウト中に行われたすべての変更を破棄します。意図しない変更を防ぐのに役立ちます。

Input

Name Type Required Description
RelativeURL String True ドキュメントを含むフォルダのサーバー相対URL。SharePoint サイト内のドキュメントを検索するのに役立ちます。
DocumentName String True チェックアウトが破棄されるファイルの名前。正しいドキュメントが処理されることを保証します。

Result Set Columns

Name Type Description
Success Boolean チェックアウト破棄操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

GetAdminConsentURL

管理者がアプリケーションへのアクセスを許可するために開く必要がある管理者の同意URL を生成します。SharePoint でOAuth 認証を構成するために不可欠です。

Input

Name Type Required Description
CallbackUrl String False ユーザーがアプリケーションを認可した後にリダイレクトされるURL。これはAzure AD アプリ設定で構成された応答URL と一致する必要があります。
State String False 認可リクエストとコールバックの間で状態を維持する値。クロスサイトリクエストフォージェリ(CSRF)攻撃を防ぐために使用されます。
Scope String False 管理者から要求されるアクセス許可。アプリケーションが受け取るアクセスレベルを決定します。

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

Result Set Columns

Name Type Description
URL String 管理者が同意を許可してアプリケーションを承認するために、Web ブラウザに入力する必要がある生成された認可URL。

CData Cloud

GetCurrentUser

現在ログインしているSharePoint ユーザーの詳細を取得します。ユーザーエクスペリエンスのパーソナライズとロールベースのアクセス制御の実施に役立ちます。

Result Set Columns

Name Type Description
Id Int SharePoint で現在認証されているユーザーの一意識別子。
Title String 現在認証されているユーザーに関連付けられた表示名またはタイトル。
Email String 現在認証されているユーザーにリンクされているプライマリメールアドレス。
IsSiteAdmin Boolean ユーザーがSharePoint サイトで管理者権限を持っているかどうかを示します。サイト管理者の場合は'true'、それ以外の場合は'false' を返します。

CData Cloud

GetJobStatus

非同期SharePoint コピー / 移動ジョブの進行状況をポーリングし、現在の状態、エラー、および関連するステータスメッセージを返します。

Input

Name Type Required Description
JobId String True コピージョブを一意に識別するGUID。ステータスをクエリするために必要です。
JobQueueUri String True このジョブに関連付けられたAzure Storage Queue のURI。ステータス更新はここにエンキューされます。
EncryptionKey String True キューからのステータスメッセージペイロードを復号化および検証するために使用されるBase64 エンコードされたAES キー。

Result Set Columns

Name Type Description
Success Boolean Boolean インジケーター:ジョブポーリング呼び出しが成功した場合はtrue、呼び出しまたはプロトコルエラーがあった場合はfalse。
JobState String ジョブの現在の状態(Queued、InProgress、Completed)。
ErrorMessage String ジョブで発生したエラーの詳細。エラーがない場合はnull。

CData Cloud

MoveAttachmentOrDocument

SharePoint 内のあるフォルダから別のフォルダに添付ファイルまたはドキュメントを移動します。ドキュメントライブラリ内のコンテンツを再編成するのに役立ちます。

実行

SourceFileURL およびDestinationFolderURL に指定されたパスは、URL で使用したパスからの相対パスである必要があります。以下のクエリ例を参照してください:

/* 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 移動するファイルの相対パス。このパスはSharePoint 接続プロパティで指定されたベースURL に対する相対パスです。
DestinationFolderURL String True ファイルが移動される宛先フォルダの相対パス。このパスもSharePoint 接続プロパティで指定されたベースURL に対する相対パスです。

Result Set Columns

Name Type Description
Success Boolean ファイルの移動操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

MoveFolderJob

SharePoint フォルダ(およびそのコンテンツ)を対象の場所に再配置する非同期移動ジョブを開始します。サイト間転送、バージョン履歴オプション、および競合解決動作をサポートします。

Input

Name Type Required Description
SourceFolderUrl String True 移動するフォルダのURL。絶対URL(https://domain.sharepoint.com/site/mysite/Shared%20Documents/SourceFolder)またはサイト相対URL(/Shared%20Documents/SourceFolder)を指定できます。ドキュメントライブラリ名を含める必要があります。
DestinationFolderUrl String True フォルダが移動される先のURL。絶対URL(https://domain.sharepoint.com/site/mysite/Target)またはサイト相対URL(/Target)を指定できます。親フォルダは既に存在している必要があります。
AllowSchemaMismatch Boolean False true の場合、ソースライブラリと宛先ライブラリのスキーマや列の構成が異なる場合でも、操作を続行できます。

デフォルト値はtrueです。

AllowSmallerVersionLimit Boolean False true の場合、宛先ライブラリのバージョン制限がソースよりも低い場合でもコンテンツの移動を許可しますが、バージョンが切り捨てられる可能性があります。

デフォルト値はtrueです。

IgnoreVersionHistory Boolean False true の場合、現在のバージョンのみがコピーされます。false の場合、移動操作中にすべてのバージョン履歴が保持されます。

デフォルト値はtrueです。

NameConflictBehavior String False 同じ名前のアイテムが宛先に存在する場合の処理を制御します:FAIL(中止)、REPLACE(上書き)、またはRENAME(一意のサフィックスを追加)。

使用できる値は次のとおりです。FAIL, REPLACE, RENAME

デフォルト値はRENAMEです。

WaitJobToFinish Boolean False true の場合、移動ジョブの完了を同期的に待機します。false の場合、非同期ステータスチェック用のジョブ追跡情報を使用して即座に戻ります。

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean 移動操作が正常に開始されたかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
JobId String この移動ジョブを一意に識別するGUID。ステータス更新を取得するためにJob Progress をポーリングする際にこの値を使用します。
JobQueueUri String このジョブに関連付けられたAzure Storage Queue のURL。システムはステータス/進行状況メッセージをそこにエンキューします。
EncryptionKey String この特定のジョブのJobQueueUri 内のステータスメッセージを復号化するために使用されるBase64 エンコードされたAES キー。
ErrorMessage String 操作が失敗した場合にエラーの詳細が含まれます。それ以外の場合は空です。

CData Cloud

RemoveRoleAssignment

SharePoint リストまたはリストアイテムから特定のロール割り当てを削除します。アクセスが不要になった場合にアクセス許可を取り消すのに役立ちます。

Input

Name Type Required Description
RoleId Int True ロール割り当てから削除されるロール定義の一意識別子。
PrincipalId Int True ロール割り当てが削除されるユーザーまたはグループの一意識別子。
List String True ロール割り当てが存在するSharePoint リストの内部名。
ItemId Int False ロール割り当てが削除されるリストアイテムの一意識別子。

Result Set Columns

Name Type Description
Success Boolean ロール割り当ての削除操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。
ErrorCode Integer プロシージャの実行が失敗した場合に返されるエラーコード。
ErrorMessage String プロシージャの実行が失敗した場合に返されるエラーメッセージ。

CData Cloud

RemoveUserFromGroup

指定されたSharePoint グループからユーザーを削除します。ユーザーのロールが変更された場合にアクセスを取り消すのに役立ちます。

Input

Name Type Required Description
LoginName String True 指定されたSharePoint グループから削除されるユーザーのログイン名。
Group String True ユーザーが削除されるSharePoint グループの名前。例:'Project Managers' または'Site Admins'。

Result Set Columns

Name Type Description
Success Boolean ユーザーがグループから正常に削除されたかどうかを示します。操作が成功した場合は'true'、それ以外の場合は'false' を返します。

CData Cloud

RenameAttachmentOrDocument

SharePoint ライブラリ内の添付ファイルまたはドキュメントの名前を変更します。コンテンツに影響を与えずにファイル名を更新するのに役立ちます。

実行

SourceFileURL に指定されたパスは、URL で使用したパスからの相対パスである必要があります。以下のクエリ例を参照してください:

/* 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 名前を変更するファイルまたは添付ファイルの相対パス。このパスはSharePoint 接続プロパティで指定されたベースURL に対する相対パスです。
NewFileName String True ファイルの新しい名前(ファイル拡張子を含む)。例:'UpdatedDocument.pdf'。

Result Set Columns

Name Type Description
Success Boolean 名前変更操作が成功したかどうかを示します。成功の場合は'true'、失敗の場合は'false' を返します。

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AuthSchemeMicrosoft SharePoint への接続に使用される認証スキームを指定します。
URL接続先のMicrosoft SharePoint サイトのベースURL を指定します。このURL は、すべてのAPI 呼び出しの開始点として使用されます。
SharePointEdition接続先のMicrosoft SharePoint エディションを指定します。
User認証に使用するMicrosoft SharePoint ユーザーアカウントを指定します。
Passwordユーザーの認証に使用するパスワードを指定します。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft SharePoint テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironment認証に使用するAzure クラウド環境を指定します。Azure アカウントのリージョン(グローバル、中国、米国政府、または米国国防総省クラウド)に合わせて設定します。

SSO


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

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
ScopeMicrosoft SharePoint データにアクセスする際の権限を要求するために使用するOAuth スコープを指定します。
State追加のOAuth ステート情報を表すオプションの値。

JWT OAuth


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuerJava Web Token の発行者。

SSL


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
CalculatedDataTypeSOAP スキーマで計算フィールドに使用するデータ型を指定します。Microsoft SharePoint が計算フィールドに予期しない型を返す場合に設定します。
ContinueOnErrorprovider がエラー発生後もバッチ更新の処理を継続するかどうかを指定します。
CreateIDColumnsSpecifies whether the provider creates supplemental ID columns for Microsoft SharePoint fields that reference values from other lists. Applies only to the SOAP schema.
DisableFilterLimitSpecifies whether to disable the 5000-record limit for list filters in Microsoft SharePoint REST queries. Setting this to true attempts server-side processing beyond the limit, but may result in server errors.
FolderOptionSpecifies how the provider displays folders and files in query results when using the SOAP schema.
GetColumnsMetadataSpecifies when the provider retrieves column metadata for tables in the REST schema. Metadata can be loaded at startup or on first use.
IncludeLookupColumnsSpecifies whether the provider includes lookup columns in query results when using the SOAP schema.
IncludeLookupDisplayValueColumnsSpecifies whether the provider includes display value columns for lookup fields in query results when using the REST schema.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がMicrosoft SharePoint にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ResolveCalculatedTypesSharePoint の計算列が、その数式の結果型に対応するSQL データ型を割り当てられるかどうかを制御します。
ShowHiddenColumnsSpecifies whether the provider includes hidden columns in metadata and query results.
ShowPredefinedColumnsSpecifies whether the provider includes predefined columns, such as system or base-type columns, in metadata and query results.
ShowVersionViewsSpecifies whether the provider includes list version views in metadata discovery when using the SOAP schema.
STSURLSpecifies the URL of the security token service (STS) used for single sign-on (SSO) authentication. This property is rarely required to be set manually.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNamesSpecifies whether the provider uses column display names instead of API names in metadata and query results.
UseEntityTypeNameSpecifies whether the provider uses a list’s EntityTypeName as the table name during metadata discovery instead of the list’s Title field.
UseNTLMV1Specifies whether the provider uses NTLMv1 or NTLMv2 for authentication.
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

Authentication

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


プロパティ説明
AuthSchemeMicrosoft SharePoint への接続に使用される認証スキームを指定します。
URL接続先のMicrosoft SharePoint サイトのベースURL を指定します。このURL は、すべてのAPI 呼び出しの開始点として使用されます。
SharePointEdition接続先のMicrosoft SharePoint エディションを指定します。
User認証に使用するMicrosoft SharePoint ユーザーアカウントを指定します。
Passwordユーザーの認証に使用するパスワードを指定します。
CData Cloud

AuthScheme

Microsoft SharePoint への接続に使用される認証スキームを指定します。

Possible Values

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

データ型

string

デフォルト値

"AzureAD"

解説

このプロパティは、お使いの環境およびID プロバイダーの要件に基づくセキュアな認証を実現します。

Microsoft SharePoint オンプレミス

Microsoft SharePoint オンプレミスインスタンスに接続する場合、このプロパティはUser およびPassword と共に、認証の処理方法を決定します。 デフォルトの認証スキームはNTLM です。利用可能なオプションは以下のとおりです。

  • Basic — HTTP Basic 認証を使用します。
  • None — 匿名認証を有効にします。通常、公開サイトへのアクセスに使用します。
  • NTLM — 認証にWindows クレデンシャルを使用します。
  • Negotiate — サーバーと認証メカニズムをネゴシエートします。Kerberos 認証を使用する場合に設定します。
  • ADFS — Active Directory Federation Services(ADFS)によるシングルサインオン(SSO)を有効にします。

Microsoft SharePoint オンライン

Microsoft SharePoint オンラインに接続する場合、AzureAD がデフォルトの認証スキームです。設定されているSchema に応じて、以下のオプションを使用できます。

REST
  • AzureAD — Azure Active Directory OAuth 認証を実行します。
  • AzureServicePrincipalCert — 証明書を使用したAzure サービスプリンシパルとして認証します。
  • AzurePassword — パスワードグラント種別でOAuth を使用して認証します。WARNING:他の(より安全な)認証方式が利用できない場合に限り、この方式を使用してください。非常に高い信頼が求められるためです。
  • AzureMSI — Azure VM で実行している際に、マネージドサービスID(MSI)資格情報を自動的に取得します。
  • SharePointOAuth — Microsoft SharePoint アプリクライアントクレデンシャルによるOAuth 認証を使用します。
  • ADFS — Active Directory Federation Services(ADFS)によるSSOを 有効にします。
  • Okta — Okta によるSSO を有効にします。
  • PingFederate — PingFederate によるSSO を有効にします。
  • OneLogin — OneLogin によるSSO を有効にします。
SOAP
  • Basic — HTTP Basic 認証を使用します。

CData Cloud

URL

接続先のMicrosoft SharePoint サイトのベースURL を指定します。このURL は、すべてのAPI 呼び出しの開始点として使用されます。

データ型

string

デフォルト値

""

解説

URL プロパティは、Cloud が接続するMicrosoft SharePoint サイトのベースエンドポイントを定義します。これには、リストやライブラリの取得、テーブルに対するCRUD 操作の実行、ストアドプロシージャの実行などが含まれます。これらはすべて、URL で定義されたサイトに関連します。有効な値の例としては、以下のようなものがあります。

  • http://server/SharePoint/
  • http://server/Sites/mysite/
  • http://server:90/
  • https://contoso.sharepoint.com/
  • https://contoso.sharepoint.com/sites/MySite/
  • https://contoso.sharepoint.com/SubSite/

末尾のスラッシュは任意です。URL が、Cloud がクエリや操作に使用するルートサイトまたはサイトコレクションを指していることを確認してください。

CData Cloud

SharePointEdition

接続先のMicrosoft SharePoint エディションを指定します。

Possible Values

SharePoint Online

データ型

string

デフォルト値

"SharePoint Online"

解説

SharePointEdition プロパティは、Cloud が接続する環境の種類を決定します。利用可能なオプションは以下のとおりです。

  • Microsoft SharePoint Online — クラウドベースの環境に接続するには、この設定を使用します。
  • Microsoft SharePoint On-Premise — オンプレミスのサーバー展開に接続するには、この設定を使用します。

追加情報

正しいエディションを選択することで、適切なAPI 処理を確実に行い、認証の失敗や予期しないエラーを回避できます。 誤った設定を使用すると、プロバイダーが互換性のないエンドポイントやプロトコルを使用しようとするため、接続に問題が生じたり、再試行回数が増えたりする可能性があります。

CData Cloud

User

認証に使用するMicrosoft SharePoint ユーザーアカウントを指定します。

データ型

string

デフォルト値

""

解説

User プロパティはPassword プロパティと共に使用され、Microsoft SharePoint サーバーに対して認証を行います。

Microsoft SharePoint オンプレミスの場合、ユーザー名には次の形式でドメインを含める必要があります:DOMAIN\Username

Microsoft SharePoint オンラインの場合、ユーザー名は通常次のような形式となります:[email protected]

CData Cloud

Password

ユーザーの認証に使用するパスワードを指定します。

データ型

string

デフォルト値

""

解説

Password プロパティはUser プロパティと共に使用され、サーバーに対して認証を行います。 パスワードは、Microsoft SharePoint に設定されたユーザーアカウントまたは関連するID プロバイダーに関連付けられた資格情報と一致している必要があります。

CData Cloud

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft SharePoint テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironment認証に使用するAzure クラウド環境を指定します。Azure アカウントのリージョン(グローバル、中国、米国政府、または米国国防総省クラウド)に合わせて設定します。
CData Cloud

AzureTenant

データにアクセスするために使用されているMicrosoft SharePoint テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。

データ型

string

デフォルト値

""

解説

テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。

Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。

このプロパティは以下の場合に必要です。

  • AuthScheme がAzureServicePrincipal またはAzureServicePrincipalCert に設定されている場合
  • AuthScheme がAzureAD で、ユーザーアカウントが複数のテナントに属している場合

テナントの値は、2つの形式のいずれかで指定できます。

  • ドメイン名(例:contoso.onmicrosoft.com)
  • GUID 形式のディレクトリ(テナント)ID(例:c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。

この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。

CData Cloud

AzureEnvironment

認証に使用するAzure クラウド環境を指定します。Azure アカウントのリージョン(グローバル、中国、米国政府、または米国国防総省クラウド)に合わせて設定します。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

Azure は、異なる地域や政府のユースケースに対応する複数のクラウド環境を提供しています。AzureEnvironment プロパティは、プロバイダーが認証時に接続する環境を決定します。 利用可能なオプションは以下のとおりです。

  • GLOBAL — デフォルトのAzure パブリッククラウド環境。
  • CHINA — Azure 中国のクラウド環境。
  • USGOVT — Azure 米国政府クラウド。米国政府機関および契約業者によって使用されます。
  • USGOVTDOD — Azure 米国国防総省(DoD)クラウド環境。

ほとんどの場合、デフォルト環境(GLOBAL)が機能します。ただし、Azure アカウントが国や政府のクラウドの一部である場合、このプロパティを適切に設定して認証エラーやURL の不一致を回避してください。

URL サフィックスの不一致の問題が発生した場合や、政府クラウドを対象とする必要がある場合は、このプロパティを使用してください。設定方法の詳細については、 Microsoft ドキュメントの「各国のクラウド」を参照してください。

CData Cloud

SSO

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


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

SSOLoginURL

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

SSODomain

シングルサインオン(SSO)認証で使用するユーザードメインが、ユーザーのログイン資格情報のドメインと異なる場合に指定します。

データ型

string

デフォルト値

""

解説

SSODomain プロパティは、シングルサインオン(SSO)経由で認証を行い、ユーザーのログイン資格情報のドメイン(例えば、[email protected])がSSO サービスで構成されたドメイン(例えば、[email protected])と異なる場合に使用されます。

このプロパティは、AuthScheme プロパティがADFS、OneLogin、Okta などのSSO 認証スキームに設定されている場合にのみ適用されます。

このプロパティは、ユーザー資格情報とSSO サービスドメインが一致しない場合に、適切な認証ルーティングを確保するために役立ちます。

追加情報

正しいSSO ドメインを指定することで、認証の失敗や不要な再試行を回避し、接続確立時間を改善できます。 必要な場合にこのプロパティを未設定のままにしておくと、ログインに何度も失敗したり、認証処理が遅くなったりする可能性があります。

CData Cloud

SSOProperties

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

データ型

string

デフォルト値

""

解説

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

SSOLoginURL と一緒に使用します。

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

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
ScopeMicrosoft SharePoint データにアクセスする際の権限を要求するために使用するOAuth スコープを指定します。
State追加のOAuth ステート情報を表すオプションの値。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

Scope

Microsoft SharePoint データにアクセスする際の権限を要求するために使用するOAuth スコープを指定します。

Possible Values

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

データ型

string

デフォルト値

"NONE"

解説

Scope プロパティは、Microsoft SharePoint への認証時にOAuth フローで要求されるアクセス許可のセットを決定します。このプロパティが指定されていないか、NONE に設定されている場合、Cloud は自動的にAuthScheme プロパティに基づいてデフォルトスコープを選択します。このデフォルトスコープは.default です。

この接続プロパティの有効なオプションは以下のとおりです。

  • AllSites.Read — カスタムリストからの読み取りを有効にします。
  • AllSites.Write — カスタムリストからの読み取りおよびカスタムリストへの書き込みを有効にします。
  • AllSites.Manage — カスタムリストの読み込み、書き込み、作成を有効にします。
  • .default — ユーザーコンテキストなしでアプリケーションのアクセス許可を要求します。そのWeb API に対して付与されたすべてのアプリケーションアクセス許可は、取得したOAuthAccessToken に含まれます。

このプロパティは、OAuth フロー中にプロバイダーが要求するアクセスレベルを制御し、返されるトークンが目的の操作に適したアクセス許可を持つようにするために役立ちます。

追加情報

AllSites.Manage などのより許容範囲が広いスコープを選択すると、リストへのフルアクセスや作成機能が可能になり操作が簡素化されますが、セキュリティ上の懸念が生じる可能性があります。 スコープを読み取りまたは書き込みに制限することで、潜在的な露出を減らすことができますが、特定の操作には再認証やスコープの変更が必要になる場合があります。 .default を使用すると、Cloud が事前承認されたアプリのアクセス許可に依存できるため、認証を効率化できますが、適切なAzure アプリの構成が必要です。

CData Cloud

State

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

JWT OAuth

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


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuerJava Web Token の発行者。
CData Cloud

OAuthJWTCert

クライアント証明書のJWT 証明書ストアの名前を指定します。

データ型

string

デフォルト値

""

解説

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

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、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"

解説

値説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy 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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

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 です。
Schemaprovider がMicrosoft SharePoint への接続に使用するスキーマの種類を指定します。
CData Cloud

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Schema

provider がMicrosoft SharePoint への接続に使用するスキーマの種類を指定します。

Possible Values

REST

データ型

string

デフォルト値

"REST"

解説

Schema プロパティは、Cloud がデータの取得と管理にどのMicrosoft SharePoint API を使用するかを決定します。利用可能なオプションは以下のとおりです。

  • SOAP — Microsoft SharePoint SOAP API を使用します。このスキーマはレガシー環境に適しており、REST API では利用できない特定の機能をサポートしています。
  • REST — Microsoft SharePoint REST API を使用します。このスキーマはより新しい環境に推奨されることが多く、最新のREST ベースの操作をサポートしています。

CData Cloud

Miscellaneous

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


プロパティ説明
CalculatedDataTypeSOAP スキーマで計算フィールドに使用するデータ型を指定します。Microsoft SharePoint が計算フィールドに予期しない型を返す場合に設定します。
ContinueOnErrorprovider がエラー発生後もバッチ更新の処理を継続するかどうかを指定します。
CreateIDColumnsSpecifies whether the provider creates supplemental ID columns for Microsoft SharePoint fields that reference values from other lists. Applies only to the SOAP schema.
DisableFilterLimitSpecifies whether to disable the 5000-record limit for list filters in Microsoft SharePoint REST queries. Setting this to true attempts server-side processing beyond the limit, but may result in server errors.
FolderOptionSpecifies how the provider displays folders and files in query results when using the SOAP schema.
GetColumnsMetadataSpecifies when the provider retrieves column metadata for tables in the REST schema. Metadata can be loaded at startup or on first use.
IncludeLookupColumnsSpecifies whether the provider includes lookup columns in query results when using the SOAP schema.
IncludeLookupDisplayValueColumnsSpecifies whether the provider includes display value columns for lookup fields in query results when using the REST schema.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がMicrosoft SharePoint にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ResolveCalculatedTypesSharePoint の計算列が、その数式の結果型に対応するSQL データ型を割り当てられるかどうかを制御します。
ShowHiddenColumnsSpecifies whether the provider includes hidden columns in metadata and query results.
ShowPredefinedColumnsSpecifies whether the provider includes predefined columns, such as system or base-type columns, in metadata and query results.
ShowVersionViewsSpecifies whether the provider includes list version views in metadata discovery when using the SOAP schema.
STSURLSpecifies the URL of the security token service (STS) used for single sign-on (SSO) authentication. This property is rarely required to be set manually.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNamesSpecifies whether the provider uses column display names instead of API names in metadata and query results.
UseEntityTypeNameSpecifies whether the provider uses a list’s EntityTypeName as the table name during metadata discovery instead of the list’s Title field.
UseNTLMV1Specifies whether the provider uses NTLMv1 or NTLMv2 for authentication.
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

CalculatedDataType

Note: Replaced by 'ResolveCalculatedTypes'.

SOAP スキーマで計算フィールドに使用するデータ型を指定します。Microsoft SharePoint が計算フィールドに予期しない型を返す場合に設定します。

Possible Values

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

データ型

string

デフォルト値

"Calculated"

解説

Note:この接続プロパティは非推奨です。代わりに、ResolveCalculatedTypes 接続プロパティを使用してCloud が計算フィールドにデータ型を割り当てる方法を設定します。

SharePoint のSOAP スキーマでは、計算フィールドはUI での設定方法に応じてさまざまなデータ型を返すことができます。 デフォルトでは、Cloud はCalculated オプションを使用し、メタデータに基づいて正しい型を検出しようと試みます。 しかし、場合によっては、計算フィールドが、検出された型と一致しない不整合な値や予期しない値を返すことがあります。 このような場合、CalculatedDataType プロパティを使用して、Cloud がこれらのフィールドに使用すべきデータ型を手動で指定することができます。

パフォーマンスの考慮事項

計算フィールドのデータ型をオーバーライドすることで、型の不一致を回避してエラーを減らし、クエリの信頼性を向上させることができます。 ただし、基となるデータと矛盾するデータ型を強制すると、変換のオーバーヘッドや値の切り捨てが発生し、大規模な結果セットの場合、クエリのパフォーマンスが低下する可能性があります。 デフォルトのCalculated 設定に従うことで、Cloud がメタデータに基づいて型処理を最適化することができます。 手動のオーバーライドは、型の不整合が問題を引き起こす場合にのみ使用してください。

CData Cloud

ContinueOnError

provider がエラー発生後もバッチ更新の処理を継続するかどうかを指定します。

データ型

bool

デフォルト値

true

解説

バッチ操作を実行すると、アイテムの追加、更新、削除中にエラーが発生することがあります。 ContinueOnError プロパティは、エラーが発生した後にCloud が処理を続行するかどうかを決定します。

true に設定すると、Cloud はバッチ内の残りのアイテムの処理を続行し、すべての可能な操作を完了させます。

false に設定すると、Cloud はエラーが発生するとすぐに処理を停止します。エラーが発生する前に処理されたアイテムは、そのまま追加、更新、または削除されます。

このプロパティはSOAP スキーマとREST スキーマの両方に適用され、バッチ操作ができるだけ多くのアイテムを処理することを優先するか、エラーに対処するために直ちに停止するかを制御するのに役に立ちます。

追加情報

エラー後も処理を続行することで、中断することなく可能な限り多くのアイテムを処理し、バッチ効率を向上させることができます。 ただし、この場合失敗したエントリに対処するためのフォローアップ処理の必要性が増す可能性があります。 エラーで停止することでトラブルシューティングが簡素化されますが、スループットが低下し、バッチの再スタートやより小さなバッチサイズの使用が必要になる場合があります。

CData Cloud

CreateIDColumns

Specifies whether the provider creates supplemental ID columns for Microsoft SharePoint fields that reference values from other lists. Applies only to the SOAP schema.

データ型

bool

デフォルト値

true

解説

In Microsoft SharePoint, certain fields, such as Lookup columns and Person or Group columns, store values that reference items in other lists. By default, when querying these fields using the SOAP schema, the Cloud returns both the value and a supplemental ID column containing the referenced entry’s ID from the original list.

When set to true, the Cloud creates these ID columns alongside the referenced values, making it easier to trace relationships and perform lookups.

When set to false, only the referenced values are returned, and the related IDs are not included.

This property is useful for preserving relational context and enabling more advanced filtering or joins when working with data that includes references to other lists.

Performance Considerations

Creating supplemental ID columns may increase the size of result sets and slightly impact performance when working with large datasets or wide tables. Disabling this property can reduce result set complexity and improve performance if the additional ID information is not needed.

CData Cloud

DisableFilterLimit

Specifies whether to disable the 5000-record limit for list filters in Microsoft SharePoint REST queries. Setting this to true attempts server-side processing beyond the limit, but may result in server errors.

データ型

bool

デフォルト値

false

解説

Microsoft SharePoint REST APIs natively support listing up to 5000 records based on list filters. For filters with 5000 or fewer records, server-side filtering provides the fastest performance.

When set to true, the Cloud attempts to delegate filtering to the server even when the filter exceeds 5000 records. However, this will likely result in a server error, as Microsoft SharePoint typically enforces the 5000-record limit.

When set to false, if a filter exceeds 5000 records, the Cloud queries from the entire list and applies filtering client-side. This avoids server errors, but introduces additional processing overhead.

This property is useful for scenarios where filter sizes vary and you need to control whether filtering happens server-side or client-side based on performance or reliability requirements.

Performance Considerations

Server-side filtering provides optimal performance for filters of 5000 records or fewer. Attempting to disable the limit for larger filters can result in server errors and failed queries. Client-side filtering allows queries to succeed beyond 5000 records, but increases data transfer and processing time, potentially impacting performance for large datasets.

CData Cloud

FolderOption

Specifies how the provider displays folders and files in query results when using the SOAP schema.

Possible Values

FilesOnly, FilesAndFolders, RecursiveAll

データ型

string

デフォルト値

"RecursiveAll"

解説

The FolderOption property determines how files and folders are displayed in query results for Microsoft SharePoint lists and libraries when using the SOAP schema. The available options include:

  • FilesOnly — Returns only files from the specified list or library, excluding folders.
  • FilesAndFolders — Returns both files and folders from the specified list.
  • RecursiveAll — Returns all files from the specified list and all subfolders.

This property is useful for controlling the scope of query results when working with lists and libraries that contain nested folder structures.

Performance Considerations

Selecting a recursive option such as RecursiveAll can increase query execution time and result set size, especially in lists with deep folder hierarchies. Using FilesOnly or FilesAndFolders may improve performance by reducing the scope of results and lowering data retrieval overhead.

CData Cloud

GetColumnsMetadata

Specifies when the provider retrieves column metadata for tables in the REST schema. Metadata can be loaded at startup or on first use.

Possible Values

OnUse, OnStart

データ型

string

デフォルト値

"OnUse"

解説

The GetColumnsMetadata property controls when the provider retrieves and caches column metadata for tables when using the REST schema. This affects how quickly queries can begin and how much upfront loading occurs. The available options include:

  • OnStart — The Cloud retrieves and caches metadata for all columns in every table before executing the first statement. This can reduce delays during queries, but may increase initial connection time.
  • OnUse — The Cloud retrieves and caches metadata for each table the first time it is queried, reducing startup time but potentially introducing a delay when the table is first accessed.

This property is useful for balancing faster connection times against the need for immediate query responsiveness across multiple tables.

Performance Considerations

Retrieving metadata on start can reduce query latency later by pre-loading all column definitions, but may significantly increase connection time, especially for large datasets. Retrieving metadata on use allows faster connections, but may delay the first query to each table as metadata is loaded on demand.

CData Cloud

IncludeLookupColumns

Specifies whether the provider includes lookup columns in query results when using the SOAP schema.

データ型

bool

デフォルト値

true

解説

Microsoft SharePoint tables can contain lookup columns, which pull data from other lists or sources. By default, the provider includes these columns when returning query results.

When set to true, the Cloud returns all defined lookup columns along with other table columns.

When set to false, lookup columns are excluded from query results, reducing the number of fields retrieved.

This property is useful for limiting query size and avoiding issues caused by Microsoft SharePoint server restrictions on the number of lookup columns returned in a single request.

Performance Considerations

Including lookup columns can significantly increase query size and complexity, especially in lists with many lookup fields. This may lead to slower performance or server rejections if the number of included lookup columns exceeds SharePoint’s internal limits. Excluding lookup columns can improve performance and reliability when working with large or complex tables.

CData Cloud

IncludeLookupDisplayValueColumns

Specifies whether the provider includes display value columns for lookup fields in query results when using the REST schema.

データ型

bool

デフォルト値

false

解説

In the REST schema, lookup columns by default return only the record identifiers that reference data from other lists. For example:

MultiLookUpColumn=1, 2
When IncludeLookupDisplayValueColumns is set to true, the Cloud includes an additional column for each lookup field with a _DisplayValue suffix. This column shows the human-readable values associated with each lookup ID. For example:
MultiLookUpColumn = 1, 2  
MultiLookUpColumn_DisplayValue = United States, United Kingdom

This property is useful for making query results more readable and eliminating the need to perform manual lookups to resolve IDs to display values.

Performance Considerations

Including display value columns increases server processing time and resource usage, as additional data must be retrieved for each lookup field. This can slow query execution and impact performance, especially when working with large lists or multiple lookup columns. Leaving this property disabled reduces query overhead.

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

CData Cloud

Pagesize

provider がMicrosoft SharePoint にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

1000

解説

クエリを処理する際、Microsoft SharePoint でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ResolveCalculatedTypes

SharePoint の計算列が、その数式の結果型に対応するSQL データ型を割り当てられるかどうかを制御します。

データ型

bool

デフォルト値

false

解説

True に設定した場合、Cloud は計算式の結果型(数値、通貨、日時、はい / いいえなど)を読み取り、その結果型を最も近いネイティブSQL 型にマッピングすることで、各計算列のデータ型を自動的に決定します。

False(デフォルト)に設定した場合、数式の結果型に関係なく、すべての計算列は文字列として扱われます。

CData Cloud

ShowHiddenColumns

Specifies whether the provider includes hidden columns in metadata and query results.

データ型

bool

デフォルト値

false

解説

The ShowHiddenColumns property determines whether hidden columns in Microsoft SharePoint lists or libraries are displayed in metadata and query results.

When set to true, hidden columns are included, allowing access to fields that are not visible by default in the Microsoft SharePoint UI.

When set to false, hidden columns are excluded from the column listing.

This property applies to both the SOAP and REST schemas and is useful for advanced querying scenarios where hidden metadata fields or internal columns need to be accessed or analyzed.

Performance Considerations

Including hidden columns may increase result set size and metadata processing time, especially for lists with many internal or system fields. Excluding hidden columns can improve performance and simplify result sets, reducing unnecessary overhead in most use cases.

CData Cloud

ShowPredefinedColumns

Specifies whether the provider includes predefined columns, such as system or base-type columns, in metadata and query results.

データ型

bool

デフォルト値

true

解説

The ShowPredefinedColumns property determines whether predefined columns, those derived from a base type, are included in the metadata and query results. Predefined columns are typically system fields, such as CreatedBy, Author, and Modified, but can also include common columns like Title.

When set to true, these columns are included in the column listing.

When set to false, all columns derived from a base type are removed from the column listing, resulting in a cleaner, more focused set of fields.

This property applies to both the SOAP and REST schemas and is useful for simplifying metadata and query output by excluding default system columns when they are not needed.

Performance Considerations

Excluding predefined columns can reduce metadata size and simplify query results, which may improve performance and readability, especially in environments with large tables and many system-defined fields. Including them provides access to additional metadata, but can increase result set complexity.

CData Cloud

ShowVersionViews

Specifies whether the provider includes list version views in metadata discovery when using the SOAP schema.

データ型

bool

デフォルト値

false

解説

The ShowVersionViews property determines whether the Cloud includes version views for Microsoft SharePoint lists during metadata discovery.

When set to true, version views are included, and versioned lists appear as additional views in the metadata, typically with names like ListName_Versions.

When set to false, these version views are excluded from the metadata listing.

This property applies only to the SOAP schema and is useful for accessing historical versions of list items when versioning is enabled.

Performance Considerations

Including version views may increase metadata discovery time and the number of views returned, particularly in environments with many versioned lists. Excluding version views helps streamline metadata loading and reduces complexity when version history is not required.

CData Cloud

STSURL

Specifies the URL of the security token service (STS) used for single sign-on (SSO) authentication. This property is rarely required to be set manually.

データ型

string

デフォルト値

""

解説

The STSURL property defines the endpoint of the security token service (STS) used during SSO authentication. In most cases, the Cloud automatically determines the correct STS URL, and this property does not need to be set.

This property may only be necessary in advanced or custom SSO configurations where the default discovery process does not resolve the correct STS endpoint.

This property is useful for troubleshooting or custom setups where the security token service URL must be specified manually to complete the authentication flow.

Additional Information

Manually specifying this property can prevent authentication delays when automatic discovery fails or points to an incorrect endpoint. However, incorrect configuration of this property can lead to failed authentication attempts and slow connection setup.

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseDisplayNames

Specifies whether the provider uses column display names instead of API names in metadata and query results.

データ型

bool

デフォルト値

true

解説

The UseDisplayNames property determines how column names are presented in metadata and query results.

When set to true, the Cloud uses the display names shown in the Microsoft SharePoint UI, making queries and results more user-friendly and readable.

When set to false, the Cloud uses the internal API names for columns, which may be less descriptive but more consistent for programmatic use.

This property applies to both the SOAP and REST schemas and is useful for aligning result sets with familiar column labels seen in the Microsoft SharePoint interface or for simplifying integration with external applications that rely on known display names.

Additional Information

Using display names can improve readability, but may introduce slight overhead during metadata retrieval, as display names must be resolved and mapped from API names. Using API names can streamline metadata processing and reduce complexity in environments where consistent field naming is preferred.

CData Cloud

UseEntityTypeName

Specifies whether the provider uses a list’s EntityTypeName as the table name during metadata discovery instead of the list’s Title field.

データ型

bool

デフォルト値

false

解説

The UseEntityTypeName property determines whether the Cloud uses the EntityTypeName of a Microsoft SharePoint list as the table name when retrieving metadata.

When set to true, the Cloud uses the list’s EntityTypeName, which can provide more consistent, API-friendly names for tables.

When set to false, the Cloud uses the list’s Title field as the table name, matching the name displayed in the Microsoft SharePoint UI.

This property applies only to the REST schema and is useful for ensuring consistent, stable naming in queries and integrations, especially when list titles are subject to change.

Additional Information

Using EntityTypeName can improve long-term stability of queries and integrations by avoiding table name changes caused by edits to list titles. However, display names may be more intuitive for end users. Switching between the two may require query updates or metadata refreshes.

CData Cloud

UseNTLMV1

Specifies whether the provider uses NTLMv1 or NTLMv2 for authentication.

データ型

bool

デフォルト値

false

解説

This property determines which version of the NTLM authentication protocol the Cloud uses when connecting.

When set to true, the Cloud attempts to connect using NTLMv1, an older and less secure version of the protocol.

When set to false, the Cloud uses NTLMv2, which is more secure and recommended for all environments.

This property is useful for compatibility with legacy systems that only support NTLMv1, though its use is discouraged in modern deployments.

Performance Considerations

Using NTLMv1 may expose connections to security vulnerabilities and is generally slower and less efficient than NTLMv2. NTLMv2 provides stronger authentication and improved performance. Only enable NTLMv1 when required for compatibility with older servers.

CData Cloud

UseSimpleNames

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

データ型

bool

デフォルト値

false

解説

Microsoft SharePoint テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

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

Notes:

  • 英数字以外の文字はアンダースコアに置き換えられます。
  • カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

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