Work IQ SharePoint リファレンス (プレビュー)

Overview

使用可能なツール

findSite

アクセスできるSharePointサイトを検索します。 検索クエリに一致する特定のサイト、またはクエリを指定しない場合は上位 20 の関連サイトを返します。

オプション パラメーター:

• Searchquery： 検索クエリ (サイト名の全体または一部)。 上位 20 のアクセス可能なサイトを返すには省略します。

getSiteByPath

正確なホスト名とサーバー相対パスを使用して、SharePoint サイトを解決します。 このメソッドは、完全なサイト URL 構造がある場合にのみ使用します。 サイト名しか知らない場合は、 findSite を使用します。

[Required parameters]\(必須のパラメーター\):

• ホスト： 正確なホスト名 (例: "contoso.sharepoint.com")
• serverRelativePath: サーバー相対パス ("sites/Marketing" など)。 先頭のスラッシュは省略可能です。

listSubsites

SharePoint サイトのすべてのサブサイト (子サイト) を一覧表示します。

[Required parameters]\(必須のパラメーター\):

• siteId: 親 SharePoint サイトの ID (形式: 'hostname,siteCollectionId,webId')

ドキュメントライブラリをサイト内で一覧表示する

指定したSharePoint サイト内のドキュメント ライブラリ (ドライブ) を一覧表示します。

オプション パラメーター:

• siteId: SharePoint サイトの ID (既定値: 'root')

getDefaultDocumentLibraryInSite（デフォルトのドキュメントライブラリをサイト内で取得する）

SharePoint サイトの既定のドキュメント ライブラリ (ドライブ) を取得します。

オプション パラメーター:

• siteId: SharePoint サイトの ID (既定値: 'root')

getFolderChildren (フォルダーの子要素を取得)

ドキュメント ライブラリ (ドライブ) 内の指定された親フォルダーに含まれる上位 20 個のファイルとフォルダー (DriveItems) を列挙します。

[Required parameters]\(必須のパラメーター\):

• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

オプション パラメーター:

• parentFolderId: 親フォルダーの ID (既定値: 'root')

ファイルまたはフォルダーを見つける

検索クエリでユーザーがアクセスできるファイルまたはフォルダー (DriveItem) を検索します。 ユーザーがアクセスできるすべてのサイトとドキュメント ライブラリを検索します。

[Required parameters]\(必須のパラメーター\):

• Searchquery： 検索クエリ (ファイル名の全体または一部)

getFileOrFolderMetadata

SharePoint内の指定したドキュメント ライブラリ (ドライブ) からファイルまたはフォルダー (DriveItem) のメタデータを取得します。

[Required parameters]\(必須のパラメーター\):

• fileOrFolderId: ファイルまたはフォルダーの ID (DriveItem)
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

getFileOrFolderMetadataByUrl (URL からファイルまたはフォルダーのメタデータを取得)

共有 URL からファイルまたはフォルダー (DriveItem) のメタデータを取得します。 ファイルにアクセスするための既存の明示的なアクセス許可を持つユーザーのみがメタデータを取得できます。

[Required parameters]\(必須のパラメーター\):

• fileOrFolderUrl: ファイルまたはフォルダーの URL。 この URL は、ユーザーと共有するためのアクセス権の付与には使用されません。ユーザーは、あらかじめ明示的にアクセス権を付与されている必要があります。

readSmallTextFile

特定のドキュメント ライブラリ (ドライブ) から 5 MB 未満のテキスト ファイルを読み取り (ダウンロード) します。

[Required parameters]\(必須のパラメーター\):

• fileId: 読み取りまたはダウンロードするファイル (DriveItem) の ID
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

readSmallBinaryFile

特定のドキュメント ライブラリ (ドライブ) から 5 MB 未満のバイナリ ファイルを読み取ります。 ファイルの内容は、base64 でエンコードされた文字列として返されます。

[Required parameters]\(必須のパラメーター\):

• fileId: 読み取りまたはダウンロードするファイル (DriveItem) の ID
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

createSmallTextFile

5 MB 未満のテキスト ファイルを作成または特定のドキュメント ライブラリ (ドライブ) にアップロードします。

[Required parameters]\(必須のパラメーター\):

• Filename： 拡張子を含むファイルの名前
• contentText: ファイルのテキスト コンテンツ
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

オプション パラメーター:

• parentFolderId: 親フォルダーの ID (既定値: 'root')

createSmallBinaryFile

特定のドキュメント ライブラリ (ドライブ) にコンテンツを base64 エンコードして、5 MB 未満のバイナリ ファイルを作成します。

[Required parameters]\(必須のパラメーター\):

• Filename： 拡張子を含むファイルの名前
• base64Content: base64 文字列としてエンコードされたバイナリ ファイルコンテンツ。
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

オプション パラメーター:

• parentFolderId: 親フォルダーの ID (既定値: 'root')

フォルダーを作成する

指定したドキュメント ライブラリ (ドライブ) 内に新しいフォルダー (DriveItem) を作成します。 同じ名前のフォルダーが存在する場合、システムは数値サフィックス (NewFolder (1) など) を追加します。

[Required parameters]\(必須のパラメーター\):

• folderName: フォルダーの名前
• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)

オプション パラメーター:

• parentFolderId: 親フォルダーの ID (既定値: 'root')

ファイルまたはフォルダーの名前を変更する

指定したドキュメント ライブラリ (ドライブ) 内のファイルまたはフォルダー (DriveItem) の名前を変更します。 新しい名前は、名前付け規則に従う必要があります。

[Required parameters]\(必須のパラメーター\):

• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)
• fileOrFolderId: 名前を変更するファイルまたはフォルダーの ID
• newFileOrFolderName: 新しい名前

オプション パラメーター:

• Etag： コンカレンシー制御の ETag

ファイルまたはフォルダーを削除

指定したドキュメント ライブラリ (ドライブ) からファイルまたはフォルダー (DriveItem) を削除します。

[Required parameters]\(必須のパラメーター\):

• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)
• fileOrFolderId: 削除するファイルまたはフォルダーの ID

オプション パラメーター:

• Etag： コンカレンシー制御の ETag

ファイルまたはフォルダを移動

ファイルまたはフォルダー (DriveItem) を移動先フォルダーに移動します。 SharePoint内の異なるドキュメント ライブラリ (ドライブ) 間での移動をサポートします。 この操作は非同期です。 checkOperationStatusを使用して進行状況を監視します。

[Required parameters]\(必須のパラメーター\):

• sourcedoclibid: ソース ドキュメント ライブラリ (ドライブ) の ID
• sourcefileid: 移動するソース ファイルまたはフォルダーの ID
• destdoclibid: コピー先ドキュメント ライブラリ (ドライブ) の ID
• destfolderid: コピー先フォルダーの ID (存在する必要があります)

オプション パラメーター:

• newfilename: 移動されたアイテムの新しい名前

ファイルまたはフォルダをコピー

ファイルまたはフォルダー (DriveItem) をコピー先フォルダーにコピーします。 SharePoint 内のさまざまなドキュメント ライブラリ間でのコピーをサポートします。 この操作は非同期です。 checkOperationStatusを使用して進行状況を監視します。

[Required parameters]\(必須のパラメーター\):

• sourcedoclibid: ソース ドキュメント ライブラリ (ドライブ) の ID
• sourcefileid: コピーするソース ファイルまたはフォルダーの ID
• destdoclibid: コピー先ドキュメント ライブラリ (ドライブ) の ID
• destfolderid: コピー先フォルダーの ID (存在する必要があります)

オプション パラメーター:

• newfilename: コピーしたアイテムの新しい名前

操作状況の確認

元の操作から返された操作トークンを使用して、コピーや移動などの非同期操作の状態を確認します。

[Required parameters]\(必須のパラメーター\):

• operationToken: 非同期操作から返される操作トークン ( copyFileOrFolder や moveFileOrFolder

URLからファイルをアップロードする

SharePointまたはOneDrive URL からドキュメント ライブラリ (ドライブ) 内の宛先フォルダーにファイルをアップロードします。 ファイルはソース URL からコピーされるため、元のファイルは変更されません。

[Required parameters]\(必須のパラメーター\):

• sourceUrl: ソース URL (有効な SharePoint または OneDrive URL である必要があります)
• destinationDocumentLibraryId: コピー先のドキュメント ライブラリの ID。 ユーザーの OneDrive には me を使用する

オプション パラメーター:

• destinationFolderId: 移動先フォルダーの ID (既定値: root)
• Filename： 新しいファイル名。既定値は元のファイル名です

ファイルまたはフォルダーを共有

指定したドキュメント ライブラリ (ドライブ) 内のファイルまたはフォルダー (DriveItem) に対する読み取りまたは書き込みアクセス許可を付与するための共有の招待を送信します。

[Required parameters]\(必須のパラメーター\):

• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)
• fileOrFolderId: 共有するファイルまたはフォルダーの ID
• recipientEmails: 受信者のメール アドレスの配列
• 役割： ロールの配列: 'read'、'write' (書き込みでは読み取りと書き込みの両方が許可されます)

オプション パラメーター:

• メッセージ： 招待メールのカスタム メッセージ (既定: 共同作業を行っているファイルを次に示します)。
• sendInvitation: 共有の招待を送信するかどうか (既定値: true)

ファイルに機密ラベルを設定する

指定したドキュメント ライブラリ (ドライブ) のファイルの秘密度ラベルを設定します。

[Required parameters]\(必須のパラメーター\):

• documentLibraryId: ドキュメント ライブラリの ID (ドライブ)
• fileId: ファイルの ID (DriveItem)
• sensitivityLabelId: 秘密度ラベルの ID、または空の文字列でそれを削除

オプション パラメーター:

• assignmentMethod: 割り当て方法: 'standard'、'privileged'、'auto'、または 'unknownFutureValue' (既定値: 'privileged')
• justificationText: 監査目的での正当な理由のテキスト。ラベルをダウングレードまたは削除する場合は必須 (既定値: 'MCPServer によって変更されました')

listLists

特定のサイトで使用可能なすべてのSharePointリストを取得します。 サイト内に存在するリストを検出するために使用します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID (形式: 'hostname,siteCollectionId,webId')

リストを作成する

サイト内に新しいSharePoint listを作成します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• Displayname： 新しいリストの表示名

オプション パラメーター:

• 列： キーと値のペアとしての列のコレクション: [{ Key: 'JobTitle', Value: 'text' }]。 有効な型: テキスト、複数行テキスト、数値、ブール値、日付時刻、選択、参照、人物またはグループ、ハイパーリンク、通貨、計算式
• テンプレート： リスト テンプレートの種類 (既定値: 'genericList')。 オプション: genericList、documentLibrary、イベント、タスク、お知らせ、連絡先、リンク、アンケート、issueTracking、discussionBoard

削除リスト

サイトからSharePoint listを削除します。 リスト コンテナー全体とその中のすべての項目を削除します。 元に戻すことはできません。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: 削除するリストの ID

オプション パラメーター:

• Etag： コンカレンシー制御の ETag

リストへの招待を送信

SharePoint リストに対するアクセス許可を付与するための共有の招待を送信します。

[Required parameters]\(必須のパラメーター\):

• listId: 共有する SharePoint リストの ID
• recipientEmails: 受信者のメール アドレスの配列
• 役割： ロール: 'read' (ビューのみ)、'contribute' (ビュー、追加、更新、アイテムの削除)、'edit' (リスト構造を含む完全な編集)

オプション パラメーター:

• Siteurl： リストを含む SharePoint サイトのサイト URL
• Sendemail： 電子メール通知を送信するかどうか (既定値: true)

listListItems

特定のSharePoint listから項目 (行/レコード) を取得します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID

getListItem

ID でSharePoint listから 1 つの項目 (行/レコード) を取得します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• Itemid： 特定のリスト アイテムの ID

リストアイテムを作成

SharePoint listに新しい項目 (行またはレコード) を作成します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• フィールド： フィールド値のキーと値のペア: [{ Key: 'Title', Value: 'Software Engineer' }, { Key: 'Department', Value: 'Engineering' }]。 通常、'Title' フィールドは必須です

リスト項目を更新

SharePoint list内の既存の項目 (行またはレコード) を更新します。 指定されたフィールドのみが更新されます。省略されたフィールドの値は保持されます。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• Itemid： 更新するアイテムの ID
• フィールド： 更新対象のフィールドのキーと値のペア

オプション パラメーター:

• Etag： コンカレンシー制御の ETag

リスト項目を削除

SharePoint listからアイテム (行またはレコード) を削除します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• Itemid： 削除するアイテムの ID

オプション パラメーター:

• Etag： コンカレンシー制御の ETag

listColumns

SharePoint listからすべての列を取得します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID

列を作成する

SharePoint listに新しい列を作成します。 テキスト、数値、選択肢、dateTime、ブール値、ユーザー、参照、計算など、多くの列の種類をサポートします。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• 名前： 内部列名 (プログラム識別子)
• columnType: 列の種類: テキスト、メモ、数値、整数、ブール値、日付時刻、選択、複数選択、通貨、参照、ユーザー、URL、計算、用語、複数用語、場所、地理位置情報、サムネイル、カウンター、計算結果、コンテンツタイプID、ファイル、添付ファイル、GUID、結果の選択、承認状況

オプション パラメーター:

• columnProperties: 型固有の設定 (テキストの { "maxLength": 255 } 、選択用の { "choices": ["A","B","C"] } など)
• 説明： 列の説明
• Displayname： UI に表示される表示名 (既定値は 'name')
• 必須： 列を必須にする (既定値: false)
• 隠さ れた： ビューから列を非表示にする (既定値: false)

列を更新

SharePoint list内の既存の列を更新します。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• columnId: 更新する列の ID

オプション パラメーター:

• columnType: 列の種類 ('columnProperties' を指定する場合に必要)
• columnProperties: 更新する型固有のプロパティ
• 説明： 新しい説明
• Displayname： 新しい表示名
• 隠さ れた： 列を表示または非表示にする
• 必須： 列を必須または省略可能にする

列を削除

SharePoint listから列を削除します。 警告： このアクションにより、その列に格納されているすべてのアイテムのデータが削除されます。

[Required parameters]\(必須のパラメーター\):

• siteId: SharePoint サイトの ID
• listId: SharePoint リストの ID
• columnId: 削除する列の ID

主要な機能

サイト管理

• 名前でサイトを検索するか、アクセス可能なサイトを参照します。
• 正確な URL パスでサイトを取得します。
• 子サイトとサブサイトを一覧表示します。
• 包括的なサイト階層ナビゲーション。

ドキュメント ライブラリの管理

• サイト内のすべてのドキュメント ライブラリを一覧表示します。
• 既定のドキュメント ライブラリを取得します。
• フォルダーの内容を参照する (最大 20 個のアイテム)
• フォルダー構造を作成および管理します。

ファイル操作

• テキスト ファイルとバイナリ ファイル (≤5 MB) を作成します。
• テキスト ファイルとバイナリ ファイル (≤5 MB) を読み取ります。
• ファイルとフォルダーを削除、名前変更、移動します。
• ドキュメント ライブラリ間でファイルとフォルダーをコピーします。
• SharePointまたはOneDrive URL からファイルをアップロードします。
• アクセス可能なすべてのサイトのファイルとフォルダーを検索します。
• ファイルとフォルダーのメタデータを取得します。

非同期操作

• ドキュメント ライブラリ間でファイルとフォルダーを非同期的にコピーおよび移動します。
• 操作トークンを使用して非同期操作の状態を確認します。

リスト操作

• リストの作成、読み取り、および削除。
• 汎用、ドキュメント ライブラリ、イベント、タスクなど、複数のリスト テンプレートのサポート。
• ロールベースのアクセス許可を持つリストを共有します。
• リスト アイテムの作成、読み取り、更新、削除を行って、リスト アイテムを管理します。

列の管理

• テキスト、メモ、数値、ブール値、dateTime、選択肢、検索、ユーザー、URL、計算など、さまざまな種類の列を作成します。
• 列のプロパティとメタデータを更新します。
• 列の要件と可視性を構成します。
• 型固有の列プロパティを設定します。

共有とアクセス許可

• ファイル、フォルダー、リストをユーザーと共有します。
• ロールベースのアクセス制御は、読み取り、書き込み、投稿、編集の各ロールで使用します。
• 共有用の電子メール通知
• 招待のカスタム メッセージ

セキュリティとコンプライアンス

• 秘密度ラベルを適用および削除します。
• 標準、特権、自動など、複数の割り当て方法を使用します。
• 監査の正当な理由をサポートします。
• eTag でコンカレンシー制御を使用します。

Notes

• ファイル操作は、アップロードおよびダウンロード用に 5 MB 以下のファイルに制限されます。
• コピー操作と移動操作は非同期です。 checkOperationStatusを使用して進行状況を監視します。
• コピー操作と移動操作では、SharePoint内のクロスライブラリ操作がサポートされます。
• uploadFileFromUrlには、有効なSharePointまたはOneDriveソース URL が必要です。
• eTag は、更新と削除のコンカレンシー制御を提供します。
• 重複するフォルダー名の自動数値サフィックス
• リストの削除を元に戻すことはできません。
• 列の削除では、その列に格納されているすべてのデータが削除されます。
• 検索操作では、既定で上位 20 件の結果が返されます。