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

Overview

使用可能なツール

getOnedrive

ドライブメタデータ、クォータ、所有者情報など、ユーザーのOneDriveに関する情報を取得します。

必須パラメーターはありません。

getFolderChildrenInMyOnedrive

ユーザーのOneDrive内の指定した親フォルダーに含まれる上位 20 個のファイルとフォルダー (DriveItems) を列挙します。

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

• parentFolderId: ファイルとフォルダーを一覧表示する親フォルダーの ID (既定値: 'root')

マイOneDrive内のファイルまたはフォルダーを見つける

ユーザーの OneDrive 内のファイルまたはフォルダー (DriveItem) を検索クエリで検索します。 アイテムがユーザーのOneDrive内にあることがわかっている場合、このメソッドは、アクセス可能なすべてのファイルを検索するよりも効率的です。

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

• Searchquery： 検索クエリ。ファイル名の全体または一部を指定できます。

getFileOrFolderMetadataInMyOnedrive

ユーザーのOneDriveからファイルまたはフォルダー (DriveItem) のメタデータを取得します。

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

• fileOrFolderId: ユーザーの OneDrive 内のファイルまたはフォルダーの ID

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

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

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

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

readSmallTextFileFromMyOnedrive

ユーザーのOneDriveからテキスト ファイルを読み取り (ダウンロード) します。

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

• fileId: 読み取りまたはダウンロードするファイル (DriveItem) の ID

MyOnedriveに小さなテキストファイルを作成する

ユーザーのOneDriveに 5 MB 未満のテキスト ファイルを作成またはアップロードします。

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

• Filename： 作成するファイルの名前
• contentText: ファイルのテキスト コンテンツ

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

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

フォルダをマイOneDriveに作成する

指定した親フォルダーの子として、ユーザーのOneDriveに新しいフォルダー (DriveItem) を作成します。 同じ名前のフォルダーが既に存在する場合、メソッドは数値サフィックス (NewFolder (1) など) を追加します。

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

• folderName: 作成するフォルダーの名前

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

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

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

ユーザーのOneDrive内のファイルまたはフォルダー (DriveItem) の名前を変更します。 新しい名前は、名前付け規則に従う必要があります。

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

• fileOrFolderId: 名前を変更するファイルまたはフォルダーの ID
• newFileOrFolderName: ファイルまたはフォルダーの新しい名前

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

• Etag： コンカレンシー制御の ETag 値。 DriveItem の現在の ETag が一致する場合にのみ、操作が成功します

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

ユーザーのOneDriveからファイルまたはフォルダー (DriveItem) を削除します。

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

• fileOrFolderId: 削除するファイルまたはフォルダーの ID

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

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

マイオンードライブ内のファイルまたはフォルダーを共有するコマンド (shareFileOrFolderInMyOnedrive)

ユーザーのOneDrive内のファイルまたはフォルダー (DriveItem) に対する読み取りまたは書き込みアクセス許可を付与する共有の招待を送信します。

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

• fileOrFolderId: 共有するファイルまたはフォルダーの ID
• recipientEmails: 招待する受信者のメール アドレスの配列
• 役割： 割り当てるロールの配列。 受け入れ可能な値: 'read'、'write' (書き込みでは読み取りと書き込みの両方が許可されます)

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

• メッセージ： 招待メールに含めるカスタム メッセージ。 既定値: '共同作業を行っているファイルは次のとおりです。'
• sendInvitation: 共有の招待を送信するかどうか。 既定値: true。

マイワンドライブ内のファイルにセンシティビティラベルを設定

ユーザーのOneDrive内のファイルの秘密度ラベルを設定します。

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

• fileId: ファイルの ID (DriveItem)
• sensitivityLabelId: 割り当てる秘密度ラベルの ID、または削除する空の文字列

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

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

マイ OneDrive に小さなバイナリファイルを作成する

ユーザーのOneDriveへのコンテンツの base64 エンコードによって、サイズが 5 MB 未満のバイナリ ファイルを作成します。

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

• Filename： 作成するファイルの名前 (ファイル拡張子を含む)
• base64Content: base64 文字列としてエンコードされたバイナリ ファイルコンテンツ

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

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

小型バイナリファイルをMyOnedriveから読む

ユーザーのOneDriveから 5 MB 未満のバイナリ ファイルを読み取ります。 ファイルの内容を base64 でエンコードされた文字列として返します。

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

• fileId: 読み取りまたはダウンロードするファイル (DriveItem) の ID

copyFileOrFolderInMyOnedrive（マイオンードライブ内のファイルまたはフォルダーをコピー）

ファイルまたはフォルダー (DriveItem) をユーザーのOneDrive内のコピー先フォルダーにコピーします。 この操作は非同期です。 checkOperationStatusInMyOnedriveを使用して進行状況を監視します。

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

• sourcefileid: コピーするソース ファイルまたはフォルダー (DriveItem) の ID
• destfolderid: 宛先フォルダーの ID (ユーザーのOneDriveに存在する必要があります)

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

• newfilename: コピーしたアイテムの新しい名前 (既定値は元の名前)

マイ OneDrive 内のファイルまたはフォルダーを移動する

ファイルまたはフォルダー (DriveItem) をユーザーのOneDrive内の移動先フォルダーに移動します。 この操作は非同期です。 checkOperationStatusInMyOnedriveを使用して進行状況を監視します。

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

• sourcefileid: 移動するソース ファイルまたはフォルダー (DriveItem) の ID
• destfolderid: 宛先フォルダーの ID (ユーザーのOneDriveに存在する必要があります)

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

• newfilename: 移動されたアイテムの新しい名前 (既定値は元の名前)

マイOneDriveで操作状況を確認する

元の操作から返された操作トークンを使用して、コピーや移動などの非同期操作の状態を確認します。 進行中の場合は進行状況情報、失敗した場合はエラーの詳細、正常に完了した場合は最終的なファイルまたはフォルダーのメタデータを返します。

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

• operationToken:copyFileOrFolderInMyOnedriveや非同期操作から返される操作トークンmoveFileOrFolderInMyOnedrive

主要な機能

OneDrive管理

• クォータや所有者などのOneDrive情報を取得します
• ユーザーの個人用 OneDrive にアクセスする
• 認証されたユーザーの OneDrive を対象とするすべての操作

ファイルの検索と検出

• ユーザーの OneDrive 内の名前でファイルとフォルダーを検索する
• ID または共有 URL でファイルまたはフォルダーのメタデータを取得する
• フォルダーの内容を参照する (最大 20 個のアイテム)

ファイル操作

• テキスト ファイルとバイナリ ファイルの作成 (≤5 MB)
• テキスト ファイルとバイナリ ファイルの読み取り (≤5 MB)
• コンカレンシー制御を使用してファイルを削除する
• eTag 保護を使用してファイルの名前を変更する
• ファイルとフォルダーを非同期的にコピーおよび移動する

フォルダー管理

• オプションの親パスを使用してフォルダーを作成する
• 重複するフォルダー名の自動数値サフィックス
• フォルダーの内容を一覧表示する (最大 20 項目)
• フォルダー メタデータを取得する
• コンカレンシー制御を使用してフォルダーを削除する
• eTag 保護を使用してフォルダーの名前を変更する

共有とアクセス許可

• ファイルとフォルダーをユーザーと共有する
• ロールベースのアクセス制御 (読み取り、書き込み)
• 共有用の電子メール通知
• 招待のカスタム メッセージ

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

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

Notes

• すべての操作は、認証されたユーザーの個人OneDriveを対象とします。
• ファイル操作は、アップロードおよびダウンロード用に 5 MB 以下のファイルに制限されます。
• 削除操作と名前変更操作では、コンカレンシー制御の eTag がサポートされます。
• 共有するには、有効な電子メール アドレスと適切なアクセス許可が必要です。
• 秘密度ラベルには、適切なライセンスと構成が必要です。
• フォルダー一覧では、既定で最大 20 個のアイテムが返されます。