CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMicrosoft SharePoint へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMicrosoft SharePoint に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Microsoft SharePoint への接続を標準化し、構成することができます。
このページでは、CData Cloud でのMicrosoft SharePoint への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft SharePoint への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してMicrosoft SharePoint からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Microsoft SharePoint に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
URL の設定:
Microsoft SharePoint は、グローバルなMicrosoft SharePoint サイト内のすべてのリストとドキュメント、または個々のサイトのすべてのリストとドキュメントで機能します。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティをサイトコレクションURL に設定します。次に例を示します。
https://teams.contoso.com
個々のサイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティを個々のサイトURL に設定します。次に例を示します。
https://teams.contoso.com/TeamA
以下のセクションでは、使用環境に適した認証プロパティの設定方法について説明します。カスタムOAuth アプリケーション(Web アプリケーションでAzureAD を使用する場合は必須、デスクトップアプリケーションまたはヘッドレスサーバー経由でAzureAD にアクセスする場合はオプション)の作成については、カスタムOAuth アプリケーションの作成 を参照してください。
SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。
Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。
もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。
Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。
AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。
接続文字列の例:AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
AuthScheme をOkta に設定します。Okta に接続するには、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
AuthScheme をPingFederate に設定します。PingFederate への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity(MSI)の資格情報を利用して接続が可能です。
MSI 資格情報が認証用に自動的に取得されます。
AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。
AuthScheme をSharePointOAuth に設定します。SharePointOAuth への接続には、次の接続プロパティを使用します。
接続文字列の例:
SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;このAuthScheme はカスタムOAuth アプリケーションで動作します。カスタムOAuth アプリケーションから認証情報を生成するには、カスタムOAuth アプリケーションの作成 を参照してください。
Kerberos でMicrosoft SharePoint への認証を行うには、AuthScheme をNEGOTIATE に設定します。
Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。
Cloud は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。
MIT Kerberos 資格情報キャッシュファイル
このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。
このオプションは、KRB5CCNAME がシステムに作成されている必要があります。
MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:
チケットの取得に成功すると、チケット情報が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 での認証に使用するユーザー / パスワードの組み合わせに設定します。
このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。
高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
Microsoft SharePoint Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
Cloud は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。
Cloud は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。
一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。
リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。
SELECT * FROM ListName WHERE ViewID='ID of the view'Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。
SELECT * FROM Views WHERE List ='ListName'
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft SharePoint | CData Schema |
| Choice (menu) | string |
| Currency | float |
| Date and Time | datetime |
| Hyperlink or Picture | string |
| Lookup | string |
| Multiple lines of text | string |
| Number | float |
| Person or Group | string |
| Single line of text | string |
| Task Outcome | string |
| Yes/No | bool |
Cloud はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Attachments | 指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。 |
| Groups | SharePoint のグループを作成、更新、削除、およびクエリします。 |
| Roles | SharePoint のロールを作成、更新、削除、およびクエリします。 |
| Users | SharePoint のユーザーを更新、削除、およびクエリします。 |
| Views | SharePoint 内にあるリストを作成、更新、削除、およびクエリします。 |
指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。
List and ItemId are required to return Attachments.
Call the AddAttachments stored procedure to add new attachments to a list item.
| Name | Type | ReadOnly | Description |
| Url [KEY] | String | True |
用語セットの説明。 |
| List | String | True |
添付ファイルの取得元になるリストの内部名。 |
| ListDisplayName | String | True |
添付ファイルの取得元になるリストの表示名。 |
| ItemID | String | True |
添付ファイルの取得元になるリスト内の項目のId。 |
| Name | String | True |
項目の添付ファイルの名前。 |
SharePoint のグループを作成、更新、削除、およびクエリします。
このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。
UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。
| Name | Type | ReadOnly | Description |
| Name# [KEY] | String | False |
グループの名前。 |
| Description# | String | False |
グループの説明。 |
| OwnerLogin# | String | False |
グループのオーナーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。 |
| OwnerType# | String | False |
オーナーのタイプ。ユーザーまたはグループ。 |
| DefaultLogin# | String | False |
グループのデフォルトユーザーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。 |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| UserName | String |
グループを取得する対象になるユーザーの論理名。指定したユーザーのグループだけを返すには、SELECTステートメントでこの値を指定します。 |
SharePoint のロールを作成、更新、削除、およびクエリします。
To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.
To insert a Role, at a minimum the Name is required:
INSERT INTO Roles (Name) VALUES ('My Role')
| Name | Type | ReadOnly | Description |
| Name# [KEY] | String | False |
ロールの名前。 |
| Description# | String | False |
ロールの説明。 |
| Permissions# | String | False |
ロールの権限を表すlong。 |
| RoleType | String | True |
ロールのタイプ。 |
| IsHidden | Boolean | True |
ロールが非表示かどうかを示すboolean。 |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| UserName | String |
ロールを取得する対象になるユーザーのログイン名。指定したユーザーに割り当てられたロールだけを返すには、SELECTステートメントでこの値を指定します。 |
| GroupName | String |
ロールを取得する対象になるグループ名。指定したグループに割り当てられたロールだけを返すには、SELECT ステートメントでこの値を指定します。 |
SharePoint のユーザーを更新、削除、およびクエリします。
Retrieves all users created for the SharePoint Account:
SELECT * FROM Users
You can retrieve Users that belong to a specific Group. In this case specify the Group Name:
SELECT * FROM Users WHERE [Group] = "GroupName"
Or you can retrieve Users that have a specific Role. In this case specify the Role Name:
SELECT * FROM Users WHERE [Role] = "RoleName"
| Name | Type | ReadOnly | Description |
| ID | String | True |
ユーザーのId。 |
| LoginName# [KEY] | String | False |
ユーザーのログイン名。 |
| Name# | String | False |
ユーザーの名前。 |
| Email# | String | False |
ユーザーのE メールアドレス。 |
| IsInDomainGroup | Boolean | True |
ユーザーがドメイングループに属するかどうかを示すboolean。 |
| IsSiteAdmin | Boolean | True |
ユーザーがサイト管理者であるかどうかを示すboolean。 |
| Notes# | String | False |
ユーザーに関するオプションのメモ。 |
| SecurityId | String | True |
ユーザーのセキュリティId(SID)。 |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Group | String |
ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
| Role | String |
ユーザーを追加、および選択/削除する先のロール。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
SharePoint 内にあるリストを作成、更新、削除、およびクエリします。
Views is a special table. It may be used to get, update, insert, and delete views from a specified List.
To return results from Views, yout must specify either the ID or List in the SELECT statement. For example,
SELECT * FROM Views WHERE List = 'MyListName'
The List, Name, and Fields columns are required to insert to this table.
| Name | Type | ReadOnly | Description |
| ID [KEY] | String | True |
ビューのId。 |
| List | String | True |
ビューを関連付けるリスト。SELECTステートメントの実行時にIdを指定しない場合は、リストを指定する必要があります。 |
| ViewID | String | True |
ビューのId。特定のリストに対して一意であれば十分です。 |
| Name | String | False |
ビューの名前。 |
| Type | String | False |
ビューのタイプ。挿入および更新では、この値を指定する必要があります。 使用できる値は次のとおりです。CALENDAR, GRID, HTML デフォルト値はHTMLです。 |
| Fields | String | False |
ビューに関連付けられたフィールドのカンマ区切りリスト。これは、スペースを文字と認識します。 |
| IsDefault | Boolean | False |
ビューがリストのデフォルトビューかどうかを示すboolean。 |
| Query | String | False |
ビューのクエリ。 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| FileVersions | SharePoint内のファイルのバージョンをリストします。 |
| GetValidTerms | 指定されたテーブルの指定された列に対して有効な用語のリストを取得します。 |
| Lists | SharePoint 内にあるリストをリストします。 |
| Permissions | サイト、もしくはリストへの許可。 Note:ItemId が空の場合は、ObjectType をList またはweb に設定します(ObjectType がlist の場合はObjectName を指定する必要があります)。そうでない場合は、ItemID とともにObjectName を指定する必要があります。 |
| Subsites | 使用可能なサブサイトをリストします。 |
SharePoint内のファイルのバージョンをリストします。
このビューから結果を返すには、Library およびFile を指定する必要があります。
| Name | Type | Description |
| ID [KEY] | String | バージョンのId。 |
| Comments | String | 特定のバージョンに関するコメント。 |
| CreateBy | String | このバージョンのファイルを変更したSharePointユーザーのユーザー名。 |
| Date | Datetime | ファイルの変更日。 |
| Size | String | このバージョンのファイルのサイズ。 |
| Url | String | このバージョンのファイルのURL。 |
| Library | String | リストするバージョンがあるSharePoint内のライブラリ名。ファイルのバージョンを取得するには、ライブラリを指定する必要があります。
デフォルト値はShared Documentsです。 |
| File | String | バージョンをリストするSharePoint内のファイルの名前。ファイルのバージョンを取得するには、ファイルを指定する必要があります。 |
指定されたテーブルの指定された列に対して有効な用語のリストを取得します。
| Name | Type | Description |
| ID [KEY] | String | 用語の識別子。 |
| TermLabelValue | String | 用語のラベル。 |
| Description | String | 用語セットの説明。 |
| NameInRequestedLang | String | クライアントから要求された言語による用語セットの名前。 |
| IsOpen | Boolean | 用語セットが開いているかどうかを示すBoolean。 |
| Deprecated | Boolean | 用語が廃止されているかどうかを示すBoolean。 |
| InternalId | String | 用語の内部識別子。 |
| TermSetContact | String | 用語セットの連絡先。 |
| ContainerDesc | String | 説明のコンテナーノード。 |
| SingleTermLabelDesc | String | これは、1つの用語ラベルを完全に記述します。 |
| IsDefaultLabel | Boolean | 用語ラベルがデフォルトの用語ラベルの場合はtrue。 |
| BelongsTo | String | この項目は、用語が所属する用語セットを記述します。 |
| IsTaggingAvailable | Boolean | 用語セットをタグ付けに使用できる場合、この値はtrueです。 |
| TermPath | String | 用語ラベルを含む用語の用語パス。 |
| TermpathoftermwithIds | String | 識別子を含む用語の用語パス。 |
| ChildTerms | String | PertainingToTermで指定された用語の子用語のカスタムソート順を示す文字列値。 |
| HasChildTerms | Boolean | 用語に子用語が含まれる場合はtrue。 |
| PertainingToTerm | String | この用語セット情報の関連先の用語の識別子。 |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| List | String | 有効な用語の取得元になるリストの名前。 |
| ColumnName | String | 有効な用語の取得元になる列の名前。 |
| LocaleId | String | 用語のロケールId。デフォルトは1033です。 |
SharePoint 内にあるリストをリストします。
Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.
The following columns can be used in the WHERE clause: Title and BaseTemplate.
| Name | Type | Description |
| ID [KEY] | String | リストのId。 |
| Title | String | リストのタイトル。この列は、WHERE句内で使用したり、ワイルドカード(*)文字と組み合わせて使用することができます。 |
| Description | String | リストの説明。 |
| BaseTemplate | String | リストの作成に使用されるテンプレートのタイプを示す。この列は、WHERE句内で使用できます。 |
| Version | Double | リストのバージョン。 |
| Url | String | リストのデフォルトURL。 |
| EmailAlias | String | リストのE メールエイリアス。 |
| ImageUrl | String | リストの画像URL。 |
| ItemCount | Integer | リスト内の項目の数。 |
| Item_Deleted | Datetime | このリスト内の項目が最後に削除された時刻。 |
| Item_Modified | Datetime | このリスト内の項目が最後に変更された時刻。 |
| SendToUrl | String | リストの送信先URL。 |
| Created | Datetime | リストの作成時刻。 |
| AllowDeletion | String | 項目を削除できるかどうか。 |
| AllowMultiResponses | Boolean | アンケートに対して複数の回答が可能かどうかを示すBoolean。 |
| Direction | String | 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。 |
| EnableAssignedToEmail | Boolean | 割り当てE メールが有効かどうかを示すBoolean。案件リストにのみ適用されます。 |
| EnableAttachments | Boolean | リスト内の項目に添付ファイルを追加できるかどうかを示すBoolean。ドキュメントライブラリには適用されません。 |
| EnableModeration | Boolean | リストにコンテンツの承認が有効かどうかを示すBoolean。 |
| EnableVersioning | Boolean | リストにバージョン管理が有効かどうかを示すBoolean。 |
| Hidden | Boolean | リストが非表示かどうかを示すBoolean。非表示のリストは、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページにルックアップフィールドのオプションとして表示されません。 |
| MultipleDataList | Boolean | 会議ワークスペースサイトに、サイト内で複数の会議インスタンスに対応するデータが含まれているかどうかを示すBoolean。 |
| Ordered | Boolean | [ビューの編集]ページでリスト内の項目をソートできるかどうかを示すBoolean。 |
| Showuser | Boolean | アンケートの結果にユーザーの名前が表示されるかどうかを示すBoolean。 |
サイト、もしくはリストへの許可。 Note:ItemId が空の場合は、ObjectType をList またはweb に設定します(ObjectType がlist の場合はObjectName を指定する必要があります)。そうでない場合は、ItemID とともにObjectName を指定する必要があります。
| Name | Type | Description |
| MemberID [KEY] | String | 許可のId。 |
| Mask | Long | Microsoft.SharePoint.SPRights 値を表し、許可を定義する0x00000000 形式の32-bit 整数。許可を合成するカスタム許可マスクを作成する場合には、C# では'|' を、Microsoft Visual Basic では'Or' を使って区切ります。 |
| MemberIsUser | Bool | ユーザーの許可かどうかを示します。 |
| MemberGlobal | Bool | グループの許可かどうかを示します。 |
| RoleName | String | サイトグループ名、クロスサイトグループ名、もしくは許可が適用されるユーザーのユーザー名(DOMAIN\User_Alias)を含む文字列。 |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ObjectName | String | リスト名もしくはサイトの名前が含まれる文字列。 |
| ObjectType | String | リスト、もしくはウェブを指定する文字列。 |
| ItemID | String | アイテムのId。 |
使用可能なサブサイトをリストします。
| Name | Type | Description |
| Title | String | サブサイトの名前。 |
| Url | String | サブサイトのURL。 |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。
| Name | Description |
| AddAttachment | SharePoint リスト項目に添付ファイルを追加します。 |
| AddList | SharePoint サイト上にリストを作成します。 |
| AddListColumn | 指定されたリストに新しいカラムを追加します。 |
| AddUserToGroup | ユーザーを指定したグループに追加します。 |
| AddUserToRole | ユーザーを指定したロールに追加します。 |
| CheckInDocument | SharePoint にドキュメントをチェックインし、ドキュメントのロックを解除します。 |
| CheckOutDocument | SharePoint からドキュメントをチェックアウトします。 |
| CopyDocument | SharePoint ライブラリからドキュメントをコピーします。 |
| CreateFolder | SharePoint サイトのドキュメントライブラリにフォルダを追加します。 |
| DeleteAttachment | SharePoint リスト項目から添付ファイルを削除します。 |
| DeleteDocument | SharePoint ライブラリからドキュメントを削除します。 |
| DeleteList | SharePoint サイトからリストを完全に削除します。 |
| DeleteListColumn | 指定されたリストからカラムを削除します。 |
| DeleteUserFromGroup | ユーザーを指定したグループから削除します。 |
| DeleteUserFromRole | ユーザーを指定したロールから削除します。 |
| DiscardCheckOutDocument | SharePoint 内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。 |
| MoveAttachmentOrDocument | ソースフォルダから宛先フォルダへドキュメントまたは添付ファイルを移動します。 |
| RenameAttachmentOrDocument | ドキュメントまたは添付ファイルの名前を変更します。 |
| UpdateList | SharePoint サイト上のリストを更新します。 |
| UpdateListColumn | 指定されたSharePoint リストのカラムを更新します。 |
SharePoint リスト項目に添付ファイルを追加します。
| Name | Type | Required | Description |
| File | String | False | 追加されるローカルファイルのパス。 |
| List | String | True | SharePoint サーバー上のリストの名前。 |
| ItemID | String | True | 添付ファイルの追加先になるリスト内の項目のId。 |
| FileName | String | False | アップロードするファイル名。コンテンツがNull でない場合に使用します。例:test.csv |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| URL | String | 新しく作成された項目のURL。 |
SharePoint サイト上にリストを作成します。
| Name | Type | Required | Description |
| Name | String | True | SharePoint サーバー上のリストの名前。 |
| Template | String | True | リスト作成のためのテンプレート名。
使用できる値は次のとおりです。GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks デフォルト値はGenericListです。 |
| Description | String | False | 追加するリストの説明。 |
| Columns | String | False | 追加するカラムの定義。json/xml/tempTable をサポート。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたリストに新しいカラムを追加します。
| Name | Type | Required | Description |
| List | String | True | SharePoint サーバー上のリストの名前。 |
| ColumnName | String | True | 追加するカラム名。 |
| DisplayName | String | False | 追加するカラムの表示名。 |
| DefaultValue | String | False | 追加するカラムのデフォルト値。 |
| ColumnType | String | True | 追加するカラムのデータ型。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。許可される値は、Integer、Text、Note、DateTime、Counter、Choice、Lookup、Boolean、Number、Currency、URL、Computed、Threading、Guid、MultiChoice、GridChoice、Calculated、File、Attachments、User、Recurrence、CrossProjectLink、ModStat、Error、ContentTypeId、PageSeparator、ThreadIndex、WorkflowStatus、AllDayEvent、WorkflowEventType、Geolocation、OutcomeChoice です。
デフォルト値はTextです。 |
| MaxLength | String | False | カラムの最大長。 |
| PrimaryKey | Boolean | False | カラムが主キーかどうかを示すBoolean。 |
| ReadOnly | Boolean | False | カラムが読み取り専用かどうかを示すBoolean。 |
| Required | Boolean | False | カラムが必須かどうかを示すBoolean。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示すBoolean 値。 |
ユーザーを指定したグループに追加します。
| Name | Type | Required | Description |
| LoginName | String | True | ユーザーのログイン名。 |
| Group | String | True | ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したロールに追加します。
| Name | Type | Required | Description |
| LoginName | String | True | ロールを割り当てたいユーザーのログイン名を含むカンマ区切りの値。例:'Domain\user1,Domain\user2' |
| Role | String | True | ユーザーに割り当てるロール。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint にドキュメントをチェックインし、ドキュメントのロックを解除します。
| Name | Type | Required | Description |
| File | String | False | SharePoint 内のドキュメントを上書きするために使用するファイルのパス。例:C:/myfolder/myfile.txt |
| Library | String | True | SharePoint サーバー上のライブラリの名前。例えば、「共有ドキュメント」です。 |
| Comment | String | False | ファイルをチェックインするときに残すコメント。 |
| RemoteFile | String | True | サーバー上のファイルのパス。これには、完全URL または単純にファイル名を指定することができます。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint からドキュメントをチェックアウトします。
| Name | Type | Required | Description |
| Library | String | True | SharePoint サーバー上のライブラリの名前。 |
| RemoteFile | String | True | サーバー上のファイルのパス。これには、完全URL または単純にファイル名を指定することができます。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
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';
| Name | Type | Required | Description |
| DocumentName | String | True | コピー元のドキュメントの、そのライブラリに対する相対位置。 |
| DocumentLibrary | String | True | コピー元のドキュメントが保存されているライブラリの表示名。 |
| NewDocumentLibrary | String | False | コピーされたドキュメントの保存先ライブラリの表示名。空欄のままにすると、新しい名前はDocumentLibrary と同じになります。 |
| NewDocumentName | String | False | コピーされたドキュメントの、新しいライブラリに対する相対位置。空欄のままにすると、新しい名前はDocumentName と同じになります。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| Id | String | ドキュメントのId。 |
| DocumentId | String | ドキュメントId。 |
| DocumentIdUrl | String | ドキュメントId のURL。 |
| FileRef | String | ドキュメントのファイル参照。 |
SharePoint サイトのドキュメントライブラリにフォルダを追加します。
| Name | Type | Required | Description |
| Library | String | True | SharePoint サーバー上のライブラリの名前。 |
| Name | String | True | ドキュメントの追加先のフォルダの名前。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint リスト項目から添付ファイルを削除します。
| Name | Type | Required | Description |
| URL | String | True | 削除される添付ファイルの完全URL。 |
| List | String | False | SharePoint サーバー上のリストの名前。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint ライブラリからドキュメントを削除します。
| Name | Type | Required | Description |
| Library | String | True | SharePoint サーバー上のライブラリの名前。 |
| Path | String | True | ドキュメントライブラリから削除するファイル(またはフォルダ)のパス。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint サイトからリストを完全に削除します。
| Name | Type | Required | Description |
| List | String | True | SharePoint サーバー上のリストの名前。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたリストからカラムを削除します。
| Name | Type | Required | Description |
| List | String | True | SharePoint サーバー上のリストの名前。 |
| ColumnName | String | True | 削除するカラム名。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示すBoolean 値。 |
ユーザーを指定したグループから削除します。
| Name | Type | Required | Description |
| LoginName | String | True | ユーザーのログイン名。 |
| Group | String | True | ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したロールから削除します。
| Name | Type | Required | Description |
| LoginName | String | True | ロールの割り当てを解除したいユーザーのログイン名を含むカンマ区切りの値。例:'Domain\user1,Domain\user2' |
| Role | String | True | ユーザーの割り当てを解除したいロール。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint 内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。
| Name | Type | Required | Description |
| Library | String | True | SharePoint サーバー上のライブラリの名前。 |
| RemoteFile | String | True | サーバー上のファイルのパス。これは完全なURL でも単にファイル名でもかまいません。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
ソースフォルダから宛先フォルダへドキュメントまたは添付ファイルを移動します。
| Name | Type | Required | Description |
| List | String | True | ドキュメントまたは添付ファイルを移動するリストの名前。 |
| SourceFileURL | String | True | ソースファイルのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。 例: Root Directory ファイル: /Shared Documents/filename.txt Sub-directory ファイル:/Shared Documents/MyFolder/filename.txt サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。 Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。 |
| DestinationFolderURL | String | True | ファイルを移動したい宛先フォルダのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。 例: Root Directory: /Shared Documents/ Sub-directory:/Shared Documents/MyFolder/ >サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。 Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
ドキュメントまたは添付ファイルの名前を変更します。
| Name | Type | Required | Description |
| List | String | True | 名前を変更したいドキュメントまたは添付ファイルを含むリストの名前。 |
| SourceFileURL | String | True | 名前を変更したいファイルのURL で、Cloud の接続プロパティで指定されたベースUrl からの相対値。 例: Root Directory ファイル: /Shared Documents/filename.txt Sub-directory ファイル:/Shared Documents/MyFolder/filename.txt サイトコレクションにUrl 接続プロパティを設定すると、相対URL はベースサイト上のパスに対応します。 Url 接続プロパティが特定のサイトを指している場合、相対URL はUrl で指定されたサイトからの相対URL となります。 |
| NewFileName | String | True | 拡張子付きの新しいファイル名。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint サイト上のリストを更新します。
| Name | Type | Required | Description |
| List | String | True | リストの名前またはGUID。 |
| AllowMultiResponses | String | False | アンケートに複数回答を許可するには、True に設定します。 |
| Description | String | False | リストの説明を含む文字列。 |
| Direction | String | False | 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。
使用できる値は次のとおりです。LTR, RTL, None |
| EnableAssignedToEmail | String | False | True に設定すると、issue リストの指定受信メールが有効になります。 |
| EnableAttachments | String | False | True に設定すると、リスト内のアイテムに添付できるようになります。ドキュメントライブラリには適用されません。 |
| EnableModeration | String | False | True に設定すると、リストのContent Approval が有効になります。 |
| EnableVersioning | String | False | True に設定すると、リストのバージョン管理が有効になります。 |
| Hidden | String | False | True に設定すると、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページに、ルックアップフィールドのオプションとしてリストが表示されなくなります。 |
| MultipleDataList | String | False | True に設定すると、会議ワークスペースサイトのリストに、サイト内の複数の会議インスタンスのデータが含まれるようにします。 |
| Ordered | String | False | True に設定すると、ユーザーがリスト内のアイテムを並べ替えることができるオプションをリストの[ビューの編集]ページで使用できるようになります。 |
| ShowUser | String | False | True に設定すると、アンケートの結果にユーザーの名前が表示されるようになります。 |
| Title | String | False | リストのタイトルを含む文字列。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたSharePoint リストのカラムを更新します。
| Name | Type | Required | Description |
| List | String | True | カラムが含まれるリストのGUID または名前。 |
| ColumnName | String | True | 更新するカラム名。 |
| DisplayName | String | False | カラムの表示名の新しい値。 |
| DefaultValue | String | False | カラムのデフォルト値の新しい値。 |
| ColumnType | String | False | カラムの型の新しい値。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。許可される値は、Integer、Text、Note、DateTime、Counter、Choice、Lookup、Boolean、Number、Currency、URL、Computed、Threading、Guid、MultiChoice、GridChoice、Calculated、File、Attachments、User、Recurrence、CrossProjectLink、ModStat、Error、ContentTypeId、PageSeparator、ThreadIndex、WorkflowStatus、AllDayEvent、WorkflowEventType、Geolocation、OutcomeChoice です。 |
| MaxLength | String | False | カラムの最大長の新しい値。 |
| PrimaryKey | Boolean | False | カラムが主キーかどうかを示すBoolean。. |
| ReadOnly | Boolean | False | カラムが読み取り専用かどうかを示すBoolean。これは新規または編集フォームでカラムを非表示にします。 |
| Required | Boolean | False | このカラムが新規または編集フォームで必須であるかどうかを示すBoolean 値。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示すBoolean 値。 |
CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。
ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。
NOTE: "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に
$select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft SharePoint | CData Schema |
| Choice (menu) | string |
| Currency | float |
| Date and Time | datetime |
| Hyperlink or Picture | string |
| Lookup | string |
| Multiple lines of text | string |
| Number | float |
| Person or Group | string |
| Single line of text | string |
| Task Outcome | string |
| Yes/No | bool |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Attachments | Reads attachments to the specified item to the specified list. |
| Comments | This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata. |
| Files | Reads attachments to the specified item to the specified list. |
| Groups | Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details. |
| Lists | Query the available lists on your sharepoint site. |
| ListItems | This view represents general SharePoint items containing standard columns across various SharePoint lists. |
| RoleAssignmentMember | Get Web RoleAssignments member. |
| RoleAssignments | Acquires Web RoleAssignments. |
| RoleDefinitionBindings | Get Web Role definition binding. |
| Roles | Contains details about role definitions available in the SharePoint site collection. |
| Subsites | This lists the available subsites. |
| Users | Represents users and their roles in the SharePoint site or group. |
Reads attachments to the specified item to the specified list.
Note: List and ItemId are required to return Attachments.
List can be fetched from the Lists view(Title column).
SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the attachment to the item. | |
| Updated | Datetime | The updated date of the attachment to the item. | |
| FileName | String | The FileName of the attachment to the item. | |
| ServerRelativePath_DecodedUrl | String | The ServerRelativePath DecodedUrl of the attachment to the item. | |
| FileNameAsPath_DecodedUrl | String | The FileNameAsPath DecodedUrl of the attachment to the item. | |
| ServerRelativeUrl | String | The ServerRelativeUrl of the attachment to the item. | |
| List | String |
Lists.Title | The internal name of the list to retrieve attachments from. |
| ItemID | Int | The Id of the item in the list to retrieve attachments from. |
This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.
| Name | Type | References | Description |
| Id [KEY] | Int | A unique identifier for each comment. | |
| ItemId [KEY] | Int |
ListItems.Id | The ID of the item associated with the comment. |
| List | String |
Lists.Title | The name of the SharePoint list containing the item and its comments. |
| ListId | String | The unique ID of the list the comment belongs to. | |
| AuthorId | Int | The unique identifier of the comment's author. | |
| AuthorEmail | String | The email address of the comment's author. | |
| IsReply | Bool | Indicates whether the comment is a reply to another comment. | |
| ParentId | Int |
Comments.Id | The unique ID of the parent comment if this is a reply. |
| ReplyCount | Int | The total number of replies to the comment. | |
| LikeCount | Int | The total number of likes on the comment. | |
| IsLikedByUser | Bool | Indicates whether the comment is liked by the current user. | |
| Text | String | The text content of the comment. | |
| Mentions | String | A list of users mentioned in the comment, if any. | |
| CreatedDate | Datetime | The date and time when the comment was originally created. | |
| ModifiedDate | Datetime | The date and time when the comment was last modified. |
Reads attachments to the specified item to the specified list.
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier | |
| CreatedBy_Id | String | The ID of the user that added the file | |
| CreatedBy_Name | String | The name of the user that added the file | |
| CreatedBy_Puid | String | The personal ID of the user that added the file | |
| ETag | String | ETag value | |
| LastModifiedBy_Id | String | The ID of the user that last modified the file | |
| LastModifiedBy_Name | String | The name of the user that last modified the file | |
| LastModifiedBy_Puid | String | The personal ID of the user that last modified the file | |
| Name | String | Name of the file including the extension | |
| Size | Long | The size of the file in bytes, excluding the size of any Web Parts that are used in the file. | |
| TimeCreated | Datetime | Specifies when the file was created. | |
| TimeLastModified | Datetime | Specifies when the file was last modified. | |
| Url | String | URL of the file | |
| List | String | The display name of the list to retrieve files from. |
Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.
| Name | Type | References | Description |
| Id [KEY] | Int | The unique identifier for the group. | |
| LoginName | String | The login name or alias associated with the group. | |
| Title | String | The display name of the group or principal. | |
| AllowMembersEditMembership | Bool | Indicates whether group members are allowed to modify the membership of the group. | |
| AllowRequestToJoinLeave | Bool | Indicates whether users can request to join or leave the group. | |
| AutoAcceptRequestToJoinLeave | Bool | Indicates whether requests to join or leave the group are automatically accepted. | |
| CanCurrentUserEditMembership | Bool | Indicates whether the current user has permissions to edit the group's membership. | |
| CanCurrentUserManageGroup | Bool | Indicates whether the current user has permissions to manage the group. | |
| CanCurrentUserViewMembership | Bool | Indicates whether the current user can view the group's membership details. | |
| Description | String | A brief description or summary of the group's purpose or function. | |
| IsHiddenInUI | Bool | Indicates whether the group is hidden from the user interface. | |
| OnlyAllowMembersViewMembership | Bool | Indicates whether only members of the group are allowed to view its membership details. | |
| OwnerTitle | String | The display name of the group's owner. | |
| RequestToJoinLeaveEmailSetting | String | The email address where membership requests (to join or leave) are sent. | |
| PrincipalType | Int | Specifies the type of principal. This is a bitwise value where possible. Types include: None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All = 15. |
Query the available lists on your sharepoint site.
Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.
The following columns can be used in the WHERE clause: Title and BaseTemplate.
| Name | Type | References | Description |
| HasUniqueRoleAssignments [KEY] | Bool | ||
| LinkedFirstUniqueAncestorSecurableObject | String | ||
| LinkedRoleAssignments | String | ||
| ServerRelativeUrl | String | The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite. | |
| Id [KEY] | String | ||
| AllowContentTypes | Bool | ||
| AllowDeletion | Bool | ||
| BaseTemplate | Int | ||
| BaseType | Int | ||
| BrowserFileHandling | Int | ||
| ContentTypesEnabled | Bool | ||
| CrawlNonDefaultViews | Bool | ||
| Created | Datetime | ||
| CurrentChangeToken_StringValue | String | ||
| CustomActionElements_Items | String | ||
| DataSource_Properties | String | ||
| DefaultContentApprovalWorkflowId | String | ||
| DefaultDisplayFormUrl | String | ||
| DefaultEditFormUrl | String | ||
| DefaultItemOpenUseListSetting | Bool | ||
| DefaultNewFormUrl | String | ||
| DefaultViewPath_DecodedUrl | String | ||
| DefaultViewUrl | String | ||
| Description | String | ||
| Direction | String | ||
| DisableGridEditing | Bool | ||
| DocumentTemplateUrl | String | ||
| DraftVersionVisibility | Int | ||
| EffectiveBasePermissions_High | Long | ||
| EffectiveBasePermissions_Low | Long | ||
| EffectiveBasePermissionsForUI_High | Long | ||
| EffectiveBasePermissionsForUI_Low | Long | ||
| EnableAssignToEmail | Bool | ||
| EnableAttachments | Bool | ||
| EnableFolderCreation | Bool | ||
| EnableMinorVersions | Bool | ||
| EnableModeration | Bool | ||
| EnableRequestSignOff | Bool | ||
| EnableVersioning | Bool | ||
| EntityTypeName | String | ||
| ExcludeFromOfflineClient | Bool | ||
| ExemptFromBlockDownloadOfNonViewableFiles | Bool | ||
| FileSavePostProcessingEnabled | Bool | ||
| ForceCheckout | Bool | ||
| HasExternalDataSource | Bool | ||
| Hidden | Bool | ||
| ImagePath_DecodedUrl | String | ||
| ImageUrl | String | ||
| IrmEnabled | Bool | ||
| IrmExpire | Bool | ||
| IrmReject | Bool | ||
| IsApplicationList | Bool | ||
| IsCatalog | Bool | ||
| IsEnterpriseGalleryLibrary | Bool | ||
| IsPrivate | Bool | ||
| IsSiteAssetsLibrary | Bool | ||
| IsSystemList | Bool | ||
| ItemCount | Int | ||
| LastItemDeletedDate | Datetime | ||
| LastItemModifiedDate | Datetime | ||
| LastItemUserModifiedDate | Datetime | ||
| ListExperienceOptions | Int | ||
| ListItemEntityTypeFullName | String | ||
| MajorVersionLimit | Int | ||
| MajorWithMinorVersionsLimit | Int | ||
| MultipleDataList | Bool | ||
| NoCrawl | Bool | ||
| OnQuickLaunch | Bool | ||
| PageRenderType | Int | ||
| ParentWebPath_DecodedUrl | String | ||
| ParentWebUrl | String | ||
| ParserDisabled | Bool | ||
| ReadSecurity | Int | ||
| SchemaXml | String | ||
| ServerTemplateCanCreateFolders | Bool | ||
| TemplateFeatureId | String | ||
| Title | String | ||
| ValidationFormula | String | ||
| ValidationMessage | String | ||
| WriteSecurity | Int | ||
| LinkedContentTypes | String | ||
| LinkedCreatablesInfo | String | ||
| LinkedDefaultView | String | ||
| LinkedDescriptionResource | String | ||
| LinkedEventReceivers | String | ||
| LinkedFields | String | ||
| LinkedForms | String | ||
| LinkedInformationRightsManagementSettings | String | ||
| LinkedItems | String | ||
| LinkedParentWeb | String | ||
| LinkedRootFolder | String | ||
| LinkedSubscriptions | String | ||
| LinkedTitleResource | String | ||
| LinkedUserCustomActions | String | ||
| LinkedViews | String | ||
| LinkedWorkflowAssociations | String |
This view represents general SharePoint items containing standard columns across various SharePoint lists.
| Name | Type | References | Description |
| ID [KEY] | Int | Unique identifier for the list item. | |
| Title | String | Title of the list item. | |
| Attachments | Bool | Indicates if the item has attachments. | |
| Description | String | Detailed description of the item. | |
| List [KEY] | String |
Lists.Title | The display name of the list to retrieve items from. |
| ContentTypeID | String | Identifier for the content type of the item. | |
| FileSystemObjectType | Int | Indicates the type of object in the file system, such as: '-1': Invalid, '0': File, '1': Folder, '2': Web. | |
| GUID | String | Globally unique identifier for the item. | |
| Version | String | The version string of the item indicates its version history. | |
| CreatedBy | Int |
Users.Id | Identifier for the author of the item. |
| ModifiedBy | Int |
Users.Id | Identifier for the last editor of the item. |
| Created | Datetime | Date and time when the item was created. | |
| Modified | Datetime | Date and time when the item was last modified. |
Get Web RoleAssignments member.
Note: PrincipalId is required to return RoleAssignmentMember.
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'MyTestList' AND ItemId = '3'
| Name | Type | References | Description |
| ID [KEY] | Int | The ID of the role assigned member. | |
| Updated | Datetime | The updated date for role assigned member. | |
| IsHiddenInUI | Boolean | A Boolean indicating if the assigned role member is hidden in UI. | |
| LoginName | String | The login name of the role assigned member. | |
| Title | String | The title of the role assigned member. | |
| PrincipalType | Int | The principal type of the role assigned member. None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All principal types = 15. | |
| AllowMembersEditMembership | Boolean | A Boolean indicating whether to allow members edit membership. | |
| AllowRequestToJoinLeave | Boolean | A Boolean indicating whether to allow request to join leave. | |
| AutoAcceptRequestToJoinLeave | Boolean | A Boolean indicating whether to auto accept request to join leave. | |
| Description | String | The description of the role assigned member. | |
| OnlyAllowMembersViewMembership | Boolean | A Boolean indicating whether to only allow members view membership. | |
| OwnerTitle | String | The owner title of the role assigned member. | |
| RequestToJoinLeaveEmailSetting | String | The request to join leave email setting of the role assigned member. | |
| List | String |
Lists.Title | The display name of the list to retrieve role assigned member from. |
| ItemId | Int | List item id for role assignment. | |
| PrincipalId | Int |
RoleAssignments.PrincipalId | The Principal Id. |
Acquires Web RoleAssignments.
SELECT * FROM RoleAssignments WHERE List = 'TestApp' SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'MyListName' AND ItemId = '3'
| Name | Type | References | Description |
| ID [KEY] | String | The Id of the role assigned. | |
| PrincipalId | Int | The Principal ID for role assigned. | |
| Updated | Datetime | The updated date for role assigned. | |
| List | String |
Lists.Title | The display name of the list to retrieve role assigned from. |
| ItemId | Int | List item id for role assignments. |
Get Web Role definition binding.
NOTE: PrincipalId is required to return RoleDefinitionBindings.
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
| Name | Type | References | Description |
| PrincipalId [KEY] | Int |
RoleAssignments.PrincipalId | The Principal Id. |
| ID [KEY] | Int | The ID of the role assigned member. | |
| BasePermissions_High | Long | The base permissions high. | |
| BasePermissions_Low | Long | The base permissions low. | |
| Description | String | The description. | |
| Hidden | Boolean | A Boolean indicating if it is hidden. | |
| Name | String | The name. | |
| Order | Int | The order. | |
| RoleTypeKind | Int | The role type kind. | |
| List | String |
Lists.Title | The display name of the list to retrieve role assigned member from. |
| ItemId | Int | List item id for role defintion. |
Contains details about role definitions available in the SharePoint site collection.
| Name | Type | References | Description |
| Id [KEY] | Int | Specifies the unique identifier of the role definition. | |
| BasePermissions_High | Long | Specifies the high-level base permissions set for the role definition. | |
| BasePermissions_Low | Long | Specifies the low-level base permissions set for the role definition. | |
| Description | String | Provides a description of the role definition's purpose and permissions. | |
| Hidden | Bool | Indicates whether the role definition is hidden from the Permission Levels page. | |
| Name | String | Defines the name assigned to the role definition. | |
| Order | Int | Specifies the display order of the role definition on the Permission Levels page in the site collection. | |
| RoleTypeKind | Int | Represents the type of role definition, mapping to an SP.RoleType enumeration. |
This lists the available subsites.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the subsite. | |
| AllowRssFeeds | Boolean | The AllowRssFeeds of the subsite. | |
| AlternateCssUrl | String | The AlternateCssUrl of the subsite. | |
| AppInstanceId | String | The AppInstanceId of the subsite. | |
| ClassicWelcomePage | String | The ClassicWelcomePage of the subsite. | |
| Configuration | Int | The Configuration of the subsite. | |
| Created | Datetime | The Created of the subsite. | |
| CurrentChangeToken_StringValue | String | The CurrentChangeToken_StringValue of the subsite. | |
| CustomMasterUrl | String | The CustomMasterUrl of the subsite. | |
| Description | String | The Description of the subsite. | |
| DesignPackageId | String | The DesignPackageId of the subsite. | |
| DocumentLibraryCalloutOfficeWebAppPreviewersDisabled | Boolean | The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite. | |
| EnableMinimalDownload | Boolean | The EnableMinimalDownload of the subsite. | |
| FooterEmphasis | Int | The FooterEmphasis of the subsite. | |
| FooterEnabled | Boolean | The FooterEnabled of the subsite. | |
| FooterLayout | Int | The FooterLayout of the subsite. | |
| HeaderEmphasis | Int | The HeaderEmphasis of the subsite. | |
| HeaderLayout | Int | The HeaderLayout of the subsite. | |
| HideTitleInHeader | Boolean | The HideTitleInHeader of the subsite. | |
| HorizontalQuickLaunch | Boolean | The HorizontalQuickLaunch of the subsite. | |
| IsHomepageModernized | Boolean | The IsHomepageModernized of the subsite. | |
| IsMultilingual | Boolean | The IsMultilingual of the subsite. | |
| IsRevertHomepageLinkHidden | Boolean | The IsRevertHomepageLinkHidden of the subsite. | |
| Language | Int | The Language of the subsite. | |
| LastItemModifiedDate | Datetime | The LastItemModifiedDate of the subsite. | |
| LastItemUserModifiedDate | Datetime | The LastItemUserModifiedDate of the subsite. | |
| LogoAlignment | Int | The LogoAlignment of the subsite. | |
| MasterUrl | String | The MasterUrl of the subsite. | |
| MegaMenuEnabled | Boolean | The MegaMenuEnabled of the subsite. | |
| NavAudienceTargetingEnabled | Boolean | The NavAudienceTargetingEnabled of the subsite. | |
| NoCrawl | Boolean | The NoCrawl of the subsite. | |
| ObjectCacheEnabled | Boolean | The ObjectCacheEnabled of the subsite. | |
| OverwriteTranslationsOnChange | Boolean | The OverwriteTranslationsOnChange of the subsite. | |
| ResourcePath_DecodedUrl | String | The ResourcePath_DecodedUrl of the subsite. | |
| QuickLaunchEnabled | Boolean | The QuickLaunchEnabled of the subsite. | |
| RecycleBinEnabled | Boolean | The RecycleBinEnabled of the subsite. | |
| SearchScope | Int | The SearchScope of the subsite. | |
| ServerRelativeUrl | String | The ServerRelativeUrl of the subsite. | |
| SiteLogoUrl | String | The SiteLogoUrl of the subsite. | |
| SyndicationEnabled | Boolean | The SyndicationEnabled of the subsite. | |
| TenantAdminMembersCanShare | Int | The TenantAdminMembersCanShare of the subsite. | |
| Title | String | The Title of the subsite. | |
| TreeViewEnabled | Boolean | The TreeViewEnabled of the subsite. | |
| UIVersion | Int | The UIVersion of the subsite. | |
| UIVersionConfigurationEnabled | Boolean | The UIVersionConfigurationEnabled of the subsite. | |
| Url | String | The Url of the subsite. | |
| WebTemplate | String | The WebTemplate of the subsite. | |
| WelcomePage | String | The WelcomePage of the subsite. | |
| AccessRequestListUrl | String | The AccessRequestListUrl of the subsite. | |
| AccessRequestSiteDescription | String | The AccessRequestSiteDescription of the subsite. | |
| Acronym | String | The Acronym of the subsite. | |
| AllowAutomaticASPXPageIndexing | Boolean | The AllowAutomaticASPXPageIndexing of the subsite. | |
| AllowCreateDeclarativeWorkflowForCurrentUser | Boolean | The AllowCreateDeclarativeWorkflowForCurrentUser of the subsite. | |
| AllowDesignerForCurrentUser | Boolean | The AllowDesignerForCurrentUser of the subsite. | |
| AllowMasterPageEditingForCurrentUser | Boolean | The AllowMasterPageEditingForCurrentUser of the subsite. | |
| AllowRevertFromTemplateForCurrentUser | Boolean | The AllowRevertFromTemplateForCurrentUser of the subsite. | |
| AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser | Boolean | The AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser of the subsite. | |
| AllowSavePublishDeclarativeWorkflowForCurrentUser | Boolean | The AllowSavePublishDeclarativeWorkflowForCurrentUser of the subsite. | |
| CommentsOnSitePagesDisabled | Boolean | The CommentsOnSitePagesDisabled of the subsite. | |
| ContainsConfidentialInfo | Boolean | The ContainsConfidentialInfo of the subsite. | |
| CustomSiteActionsDisabled | Boolean | The CustomSiteActionsDisabled of the subsite. | |
| DefaultNewPageTemplateId | String | The DefaultNewPageTemplateId of the subsite. | |
| DescriptionForExistingLanguage | String | The DescriptionForExistingLanguage of the subsite. | |
| DescriptionTranslations | String | The DescriptionTranslations of the subsite. | |
| DesignerDownloadUrlForCurrentUser | String | The DesignerDownloadUrlForCurrentUser of the subsite. | |
| DisableAppViews | Boolean | The DisableAppViews of the subsite. | |
| DisableFlows | Boolean | The DisableFlows of the subsite. | |
| DisableRecommendedItems | Boolean | The DisableRecommendedItems of the subsite. | |
| EffectiveBasePermissions_High | Long | The EffectiveBasePermissions_High of the subsite. | |
| EffectiveBasePermissions_Low | Long | The EffectiveBasePermissions_Low of the subsite. | |
| ExcludeFromOfflineClient | Boolean | The ExcludeFromOfflineClient of the subsite. | |
| HasWebTemplateExtension | Boolean | The HasWebTemplateExtension of the subsite. | |
| IsEduClass | Boolean | The IsEduClass of the subsite. | |
| IsEduClassProvisionChecked | Boolean | The IsEduClassProvisionChecked of the subsite. | |
| IsEduClassProvisionPending | Boolean | The IsEduClassProvisionPending of the subsite. | |
| IsProvisioningComplete | Boolean | The IsProvisioningComplete of the subsite. | |
| LastItemModifiedDate | Datetime | The LastItemModifiedDate of the subsite. | |
| LastItemUserModifiedDate | Datetime | The LastItemUserModifiedDate of the subsite. | |
| LogoAlignment | Int | The LogoAlignment of the subsite. | |
| NotificationsInOneDriveForBusinessEnabled | Boolean | The NotificationsInOneDriveForBusinessEnabled of the subsite. | |
| NotificationsInSharePointEnabled | Boolean | The NotificationsInSharePointEnabled of the subsite. | |
| PrimaryColor | String | The PrimaryColor of the subsite. | |
| RelatedHubSiteIds | String | The RelatedHubSiteIds of the subsite. | |
| RequestAccessEmail | String | The RequestAccessEmail of the subsite. | |
| SaveSiteAsTemplateEnabled | Boolean | The SaveSiteAsTemplateEnabled of the subsite. | |
| SearchBoxInNavBar | Int | The SearchBoxInNavBar of the subsite. | |
| SearchBoxPlaceholderText | String | The SearchBoxPlaceholderText of the subsite. | |
| ServerRelativePath_DecodedUrl | String | The ServerRelativePath_DecodedUrl of the subsite. | |
| ShowUrlStructureForCurrentUser | Boolean | The ShowUrlStructureForCurrentUser of the subsite. | |
| SiteLogoDescription | String | The SiteLogoDescription of the subsite. | |
| SupportedUILanguageIds | String | The SupportedUILanguageIds of the subsite. | |
| TenantTagPolicyEnabled | Bit | The TenantTagPolicyEnabled of the subsite. | |
| ThemeData | String | The ThemeData of the subsite. | |
| ThemedCssFolderUrl | String | The ThemedCssFolderUrl of the subsite. | |
| ThirdPartyMdmEnabled | Boolean | The ThirdPartyMdmEnabled of the subsite. | |
| TitleForExistingLanguage | String | The TitleForExistingLanguage of the subsite. | |
| TitleTranslations | String | The TitleTranslations of the subsite. | |
| WebTemplateConfiguration | String | The WebTemplateConfiguration of the subsite. | |
| WebTemplatesGalleryFirstRunEnabled | Boolean | The WebTemplatesGalleryFirstRunEnabled of the subsite. | |
| WebTemplatesGalleryFirstRunComplete | Boolean | The WebTemplatesGalleryFirstRunComplete of the subsite. |
Represents users and their roles in the SharePoint site or group.
SELECT * FROM Users // Fetch all the Users SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group
| Name | Type | References | Description |
| Id [KEY] | Int | Unique identifier for each user in the SharePoint environment. | |
| LoginName | String | The unique login name used by the user to access the SharePoint environment. | |
| Title | String | The display name or title associated with the user. | |
| IsHiddenInUI | Bool | Indicates whether the user is hidden from the SharePoint user interface. | |
| GroupId | Int | The identifier of the group to which the user belongs. | |
| AadObjectId_NameId | String | Azure Active Directory (AAD) object ID representing the user's unique identifier. | |
| AadObjectId_NameIdIssuer | String | The issuer of the Azure Active Directory (AAD) NameId for the user. | |
| String | Primary email address associated with the user. | ||
| EmailWithFallback | String | An alternate or fallback email address for the user if the primary is unavailable. | |
| Expiration | String | Specifies the expiration date of the user's access, if applicable. | |
| HexCid | String | A hexadecimal representation of the user's client ID. | |
| IsEmailAuthenticationGuestUser | Bool | Indicates if the user is a guest authenticated via email. | |
| IsShareByEmailGuestUser | Bool | Indicates if the user is a guest invited via email for sharing purposes. | |
| IsSiteAdmin | Bool | Specifies whether the user has administrative rights for the site collection. | |
| UserId_NameId | String | The unique identifier for the user in SharePoint's user ID system. | |
| UserId_NameIdIssuer | String | The issuer of the user's ID in SharePoint's user ID system. | |
| UserPrincipalName | String | User Principal Name (UPN) for the user, usually an email-style identifier. | |
| PrincipalType | Int | Defines the type of principal, using bitwise values: None=0, User=1, DistributionList=2, SecurityGroup=4, SharePointGroup=8, All=15. |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。
| Name | Description |
| AddAttachment | SharePoint リストに添付ファイルを追加します。 |
| AddImage | Sharepoint のリスト項目に画像を追加します。 |
| AddList | SharePoint サイト上にリストを作成します。 |
| AddListColumn | 指定されたリストに新しいカラムを追加します。 |
| AddRoleAssignment | Adds a new role assignment with the specified principal and role definitions to the list, or list item. |
| BreakRoleInheritance | Breaks the security inheritance of a list, or list item so that role assignments on the parent object no longer apply to the child object. |
| CheckInDocument | 特定のドキュメントをドキュメントライブラリにチェックインします。 |
| CheckOutDocument | ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。 |
| CopyDocument | Copies the file to the destination URL.. |
| CreateFolder | SharePoint サイトのドキュメントライブラリにフォルダを追加します。 |
| DeleteAttachment | Deletes an attachment from Sharepoint list. |
| DeleteDocument | Deletes a Document from the SharePoint document library. |
| DeleteList | SharePoint サイトからリストを完全に削除します。 |
| DeleteListColumn | 指定されたリストからカラムを削除します。 |
| DiscardCheckOutDocument | Reverts an existing checkout for the file. |
| GetAdminConsentURL | アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。 |
| GetCurrentUser | 現在ログインしているユーザーの情報を取得します。 |
| MoveAttachmentOrDocument | Moves a document or attachment from a source folder to a destination folder. |
| RemoveRoleAssignment | Removes the role assignment with the specified principal and role definition from the list, or list item. |
| RenameAttachmentOrDocument | Renames a document or attachment. |
SharePoint リストに添付ファイルを追加します。
| Name | Type | Required | Description |
| ListTitle | String | True | リストアイテムのタイトル。 |
| ItemId | String | True | リストアイテムのId。 |
| FileName | String | True | ドキュメントライブラリに追加するファイル名。 |
| InputFilePath | String | False | ファイルを添付する場所。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| RelativeUrl | String | 追加された添付ファイルの相対URL。 |
Sharepoint のリスト項目に画像を追加します。
| Name | Type | Required | Description |
| ListName | String | True | SharePoint 上のリストの表示名。 |
| ItemId | String | True | リストアイテムのId。 |
| ColumnInternalName | String | True | 追加するカラム名。 |
| FileName | String | True | 画像として追加するファイル名。 |
| InputFilePath | String | False | ファイルを添付する場所。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| ErrorCode | Integer | このプロシージャが正常に実行されなかった場合、この出力には、失敗した実行に関連するエラーコードが表示されます。 |
| ErrorMessage | String | このプロシージャが正常に実行されなかった場合、この出力には、失敗した実行に関連するエラーメッセージが表示されます。 |
SharePoint サイト上にリストを作成します。
| Name | Type | Required | Description |
| Name | String | True | SharePoint サーバー上のリストの名前。 |
| Template | String | False | リスト作成のためのテンプレート名またはId。 |
| Description | String | False | 追加するリストの説明。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| ErrorCode | Integer | プロシージャが正常に実行されなかった場合のエラーコード。 |
| ErrorMessage | String | プロシージャが正常に実行されなかった場合のエラーメッセージ。 |
指定されたリストに新しいカラムを追加します。
| Name | Type | Required | Description |
| ListName | String | True | SharePoint 上のリストの表示名。 |
| ColumnDisplayName | String | True | 追加するカラムの表示名。 |
| ColumnType | String | True | 追加するカラムのデータ型。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://docs.microsoft.com/ja-jp/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。 |
| ColumnInternalName | String | False | 追加するカラム名。 |
| IsRequired | Boolean | False | カラムが必須かどうかを示すBoolean。 |
| EnforceUniqueValues | Boolean | False | カラムに一意な値を指定するかどうかを示すBoolean。 |
| DisplayAfterCreation | Boolean | False | 追加されたフィールドをSharePoint UI に表示するかどうかを示すBoolean。デフォルト値はtrue です。 |
| LookupListId | String | False | ルックアップしたいフィールドの場所のリストId。 |
| LookupFieldName | String | False | ルックアップしたいフィールドの表示名。 |
| Name | Type | Description |
| Success | Boolean | 操作が正常に実行されたかどうかを示します。 |
| ErrorCode | Integer | プロシージャが正常に実行されなかった場合のエラーコード。 |
| ErrorMessage | String | プロシージャが正常に実行されなかった場合のエラーメッセージ。 |
Adds a new role assignment with the specified principal and role definitions to the list, or list item.
| Name | Type | Required | Description |
| RoleId | Int | True | The ID of the role definition that defines the permissions to assign. |
| PrincipalId | Int | True | The ID of the user or group to assign permissions to. |
| List | String | True | The internal name of the list to add the role assignment. |
| ItemId | Int | False | The list item id to add the role assignment. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
| ErrorCode | Integer | The error code in case the procedure is not executed successfully. |
| ErrorMessage | String | The error message in case the procedure is not executed successfully. |
Breaks the security inheritance of a list, or list item so that role assignments on the parent object no longer apply to the child object.
| Name | Type | Required | Description |
| List | String | True | The internal name of the list to break the security inheritance. |
| ItemId | Int | False | The list item id to break the security inheritance. |
| CopyRoleAssignments | Boolean | False | Specifies whether to copy the role assignments from the parent object.
デフォルト値はtrueです。 |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
| ErrorCode | Integer | The error code in case the procedure is not executed successfully. |
| ErrorMessage | String | The error message in case the procedure is not executed successfully. |
特定のドキュメントをドキュメントライブラリにチェックインします。
| Name | Type | Required | Description |
| RelativeURL | String | True | フォルダの相対URL。 |
| DocumentName | String | True | チェックインするファイル名。 |
| Comment | String | False | ドキュメントをチェックインする際の任意のメッセージ。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。
| Name | Type | Required | Description |
| RelativeURL | String | True | フォルダの相対URL。 |
| DocumentName | String | True | チェックインするファイル名。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
Copies the file to the destination URL..
| Name | Type | Required | Description |
| SourceFileRelativeUrl | String | True | The relative URL of the source file. |
| DestFileRelativeUrl | String | True | The relative URL of the destination file. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
SharePoint サイトのドキュメントライブラリにフォルダを追加します。
| Name | Type | Required | Description |
| RelativeURL | String | True | フォルダの相対URL。 |
| FolderName | String | True | 作成するフォルダ名。 |
| SiteURL | String | False | このフォルダを作成するサイトのベースURL('URL' 接続プロパティのものと同じSharePoint インスタンス内 / 同じドメイン内)。このパラメータが使用される場合、この値は'URL' 接続プロパティの値よりも優先されます。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| Id | String | 操作の完了後に返される一意の識別子の値。 |
Deletes an attachment from Sharepoint list.
| Name | Type | Required | Description |
| ListTitle | String | True | The Title of the list item. |
| ItemId | String | True | The Id of the list item. |
| FileName | String | True | The name of the file to be added to the document library |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
Deletes a Document from the SharePoint document library.
| Name | Type | Required | Description |
| RelativePath | String | True | The path of the document you want to delete, relative to the value specified in the URL connection property. For example: '/Shared Documents/My Folder/My Document.txt'. |
| Permanently | String | False | If True, deletes the document permanently. Otherwise, the Cloud moves the document to the recycle bin.
デフォルト値はfalseです。 |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful. |
| ErrorCode | Integer | When this procedure is not executed successfully, this output displays the error code associated with the failed execution. |
| ErrorMessage | String | When this procedure is not executed successfully, this output displays the error message associated with the failed execution. |
SharePoint サイトからリストを完全に削除します。
| Name | Type | Required | Description |
| Name | String | True | SharePoint サーバー上のリストの名前。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| ErrorCode | Integer | プロシージャが正常に実行されなかった場合のエラーコード。 |
| ErrorMessage | String | プロシージャが正常に実行されなかった場合のエラーメッセージ。 |
指定されたリストからカラムを削除します。
| Name | Type | Required | Description |
| ListName | String | True | SharePoint 上のリストの表示。 |
| ColumnName | String | True | 削除するカラムの表示名。 |
| Name | Type | Description |
| Success | Boolean | 操作が成功したかどうかを示します。 |
| ErrorCode | Integer | プロシージャが正常に実行されなかった場合のエラーコード。 |
| ErrorMessage | String | プロシージャが正常に実行されなかった場合のエラーメッセージ。 |
Reverts an existing checkout for the file.
| Name | Type | Required | Description |
| RelativeURL | String | True | The relative URL of the folder. |
| DocumentName | String | True | The name of the file to be checked in. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。
| Name | Type | Required | Description |
| CallbackUrl | String | False | アプリケーションが認可された後にユーザーがリダイレクトされるURL。この値は、Azure AD アプリ設定内のリダイレクトURL に合致する必要があります。 |
| State | String | False | 認証コードをリクエストしたときに送信した状態と同じ値。 |
| Scope | String | False | 管理者にリクエストしているスコープまたは権限。
デフォルト値はAllSites.Manageです。 |
| Name | Type | Description |
| URL | String | ベリファイアトークンを取得してアプリを認可するためにWeb ブラウザに入力される、認可URL。 |
現在ログインしているユーザーの情報を取得します。
| Name | Type | Description |
| Id | Int | ユーザーId。 |
| Title | String | ユーザーの役職。 |
| String | ユーザーの電子メール。 | |
| IsSiteAdmin | Boolean | ユーザーがサイト管理者かどうか。 |
Moves a document or attachment from a source folder to a destination folder.
The paths specified in SourceFileURL and DestinationFolderURL must be relative to what you have used in Url. Refer to the query example below:
/* URL = https://mysite.sharepoint.com/sites/Subsite */ EXEC MoveAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', DestinationFolderURL = '/Destination Library/Destination Folder/';
| Name | Type | Required | Description |
| SourceFileURL | String | True | The path of the source file, relative to the base Url supplied in the Cloud's connection properties. |
| DestinationFolderURL | String | True | The path of the destination folder where you want to move the file, relative to the base Url supplied in the Cloud's connection properties. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
Removes the role assignment with the specified principal and role definition from the list, or list item.
| Name | Type | Required | Description |
| RoleId | Int | True | The ID of the role definition in the role assignment. |
| PrincipalId | Int | True | The ID of the user or group in the role assignment |
| List | String | True | The internal name of the list to remove the role assignment. |
| ItemId | Int | False | The list item id to remove the role assignment. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
| ErrorCode | Integer | The error code in case the procedure is not executed successfully. |
| ErrorMessage | String | The error message in case the procedure is not executed successfully. |
Renames a document or attachment.
The path specified in SourceFileURL must be relative to what you have used in Url. Refer to the query example below:
/* URL = https://mysite.sharepoint.com/sites/Subsite */ EXEC RenameAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', NewFileName = 'Renamed Document.txt';
| Name | Type | Required | Description |
| SourceFileURL | String | True | The path of the file you want to rename, relative to the base Url supplied in the Cloud's connection properties. |
| NewFileName | String | True | The new name of the file, with a file extension. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
| プロパティ | 説明 |
| AuthScheme | SharePoint への認証に使用されるスキーム。 |
| URL | サイトのベースURL。 |
| SharePointEdition | 使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。 |
| User | 認証で使用されるSharePoint ユーザーアカウント。 |
| Password | ユーザーの認証で使用されるパスワード。 |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft SharePoint テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き) |
| AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSODomain | シングルサインオン(SSO)を使用する場合のユーザーのドメイン。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | The scope used for the OAuth flow to access data from the Application. |
| State | 追加のOAuth ステート情報を表すオプションの値。 |
| OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Schema | 使用するスキーマの種類。 |
| プロパティ | 説明 |
| CalculatedDataType | 計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。 |
| ContinueOnError | エラー後にバッチ内の項目の更新を続行するかどうかを示します。 |
| CreateIDColumns | 他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。 |
| DisableFilterLimit | Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema. |
| FolderOption | 結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。 |
| GetColumnsMetadata | Specifies when the provider should retrieve column metadata. This property applies only to the REST schema. |
| IncludeLookupColumns | このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。 |
| IncludeLookupDisplayValueColumns | Determines whether the display values for lookup columns should be included. This property applies only to the REST schema. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Pagesize | Microsoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| ShowHiddenColumns | 非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。 |
| ShowPredefinedColumns | 定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 |
| ShowVersionViews | メタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。 |
| STSURL | シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UseDisplayNames | API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。 |
| UseEntityTypeName | Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema. |
| UseNTLMV1 | ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |