埋め込みSharePoint
Microsoft SharePoint Embedded は、あらゆるアプリケーションでの使用に適したクラウドベースのファイルおよびドキュメント管理システムです。 SharePoint Embedded は、アプリ開発者が任意のアプリのMicrosoft 365 ファイルとドキュメント ストレージ プラットフォームの機能を利用できるようにする API 専用ソリューションであり、基幹業務アプリケーションを構築する企業やマルチテナント アプリケーションを構築する ISV に適しています。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| Copilot Studio | Standard | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - 中国リージョンAzure - 米国国防総省 (DoD) |
| Power Apps | Standard | 次を除くすべてのPower Appsリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Standard | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft |
| URL | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| spe-connector@service.microsoft.com |
| コネクタ メタデータ | |
|---|---|
| パブリッシャー | Microsoft |
| Web サイト | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| プライバシー ポリシー | https://privacy.microsoft.com/ |
| カテゴリ | コンテンツとファイル |
はじめに
SharePoint Embedded コネクタを使用する前に、SharePoint Embedded アプリケーションを作成する必要があります。 詳細については、SharePoint Embedded のドキュメントを参照してください。
SharePoint 埋め込みコネクタへのアクセス権を付与する
SharePoint Embedded コネクタがテナント内のファイル ストレージ コンテナーとコンテンツと対話するには、そのテナントの containerTypeRegistration で、SharePoint Embedded コネクタ アプリケーション用の applicationPermissionGrant を作成する必要があります。 これにより、SharePoint Embedded コネクタは、テナント上のアプリの特定のコンテナーの種類にアクセスできます。
Microsoft Graph API を使用した delegated 呼び出しの SharePoint Embedded コネクタ アプリケーション ID e8e1b0bf-140f-4b8b-8e94-fbe8937fad04 に、delegated アクセス許可を付与します。
PUT /storage/fileStorage/containerTypeRegistrations/{containerTypeId}/applicationPermissionGrants/e8e1b0bf-140f-4b8b-8e94-fbe8937fad04
Content-Type: application/json
{
"delegatedPermissions": ["full"],
"applicationPermissions": ["none"]
}
詳細については、 fileStorageContainerTypeAppPermissionGrant API リファレンス記事を参照してください。
既知の問題と制限事項
- ファイルの作成タスクでサポートされる最大ファイル サイズは 10 MB です
- コンテナーの作成はコネクタでは使用できません
- 委任された認証のみがサポートされています
アクション
| コンテナの削除 |
コンテナーを削除する |
| コンテナーのアクセス許可を一覧表示する |
コンテナーに対するアクセス許可を一覧表示する |
| コンテナーのアクセス許可を削除する |
コンテナーに対するアクセス許可を削除する |
| コンテナーのアクセス許可を更新する |
コンテナーのアクセス許可を更新する |
| コンテナーのアクティブ化 |
コンテナーをアクティブ化する |
| コンテナーのカスタム プロパティを取得する |
コンテナーのカスタム プロパティを取得する |
| コンテナーのカスタム プロパティを更新する |
コンテナーのカスタム プロパティを更新する |
| コンテナーの一覧表示 |
コンテナーの一覧表示 |
| コンテナーの作成アクセス許可 |
コンテナーに対するアクセス許可を作成する |
| コンテナーの取得 |
コンテナーの取得 |
| コンテナーを更新する |
コンテナーを更新する |
| コンテナー内のアイテムを一覧表示する |
この操作では、コンテナー内のファイルとサブフォルダーの一覧を取得します。 |
| コンテナー列の作成 |
コンテナーのスキーマを定義する列を作成する |
| コンテナー列の削除 |
コンテナーのスキーマを定義する列を削除する |
| コンテナー列を一覧表示する |
コンテナーのスキーマを定義する列を一覧表示する |
| コンテナー列を取得する |
コンテナーの列を取得する |
| サムネイルを一覧表示する |
この操作では、SharePoint Embedded コンテナー内のファイルで使用可能なサムネイルが一覧表示されます。 |
| サムネイルを取得する |
この操作では、SharePoint Embedded コンテナー内のファイルの特定のサムネイルを取得します。 |
| チェック アウトを破棄 |
この操作により、SharePoint Embedded コンテナー内のファイルからチェックアウトが破棄されます。 |
| ファイル バージョンの削除 |
この操作により、SharePoint Embedded コンテナー内の特定のバージョンのファイルが削除されます。 |
| ファイル フィールドを一覧表示する |
この操作では、SharePoint Embedded コンテナー内のファイルに関連付けられているリスト アイテム フィールド (メタデータ) を取得します。 |
| ファイル フィールドを設定する |
この操作により、SharePoint Embedded コンテナー内のファイルに関連付けられているリスト アイテム フィールド (メタデータ) が更新されます。 null 値を使用してフィールド値をクリアします。 |
| ファイルのチェックイン |
この操作は、SharePoint Embedded コンテナーでチェックアウトされたファイルをチェックインします。 |
| ファイルのバージョンを一覧表示する |
この操作では、SharePoint Embedded コンテナー内のファイルの以前のバージョンが一覧表示されます。 |
| ファイルのバージョンを取得する |
この操作では、SharePoint Embedded コンテナー内のファイルの特定のバージョンを取得します。 |
| ファイルのプレビューを作成する |
この操作により、SharePoint Embedded コンテナー内のファイルのプレビューが作成されます。 |
| ファイルのプロパティの取得 |
この操作では、SharePoint Embedded コンテナー内のファイルのプロパティを取得します。 |
| ファイルの内容を取得する |
この操作は、ファイルの内容を取得します。 |
| ファイルの内容を更新する |
この操作により、ファイルの内容が更新されます。 |
| ファイルをチェックアウトする |
この操作により、SharePoint Embedded コンテナー内のファイルがチェックアウトされ、他のユーザーがドキュメントを編集できなくなります。 |
| ファイルを作成する |
この操作により、ファイルが作成され、driveItem のメタデータが返されます。 |
| ファイルを削除する |
この操作により、SharePoint Embedded コンテナー内のファイルが削除されます。 |
| ファイル名の変更 |
この操作により、SharePoint Embedded コンテナー内のファイルの名前が変更されます。 |
| フォルダーを作成する |
この操作により、ルート レベルまたは別のフォルダー内の SharePoint Embedded コンテナーに新しいフォルダーが作成されます。 |
| リサイクルされたアイテムを一覧表示する |
この操作では、SharePoint埋め込みコンテナーのごみ箱内のアイテムが一覧表示されます。 |
| リサイクルされたアイテムを削除する |
この操作により、SharePoint埋め込みコンテナーのごみ箱から 1 つ以上のリサイクル済みアイテムが完全に削除されます。 |
| リサイクルされたアイテムを復元する |
この操作により、SharePoint埋め込みコンテナーのごみ箱から 1 つ以上のリサイクルされたアイテムが復元されます。 |
| リサイクルされたコンテナーを一覧表示する |
リサイクルされたコンテナーを一覧表示する |
| リサイクルされたコンテナーを削除する |
リサイクルされたコンテナーを完全に削除する |
| リサイクルされたコンテナーを復元する |
リサイクルされたコンテナーを復元する |
| リスト アイテムの共有アクセス許可 |
この操作では、SharePoint Embedded コンテナー内のアイテムの共有アクセス許可が一覧表示されます。 |
| 共有の招待を送信する |
この操作により、SharePoint Embedded コンテナー内のファイルの共有の招待が送信されます。 |
| 共有アクセス許可を削除する |
この操作により、SharePoint Embedded コンテナー内のファイルに対する特定の共有アクセス許可が削除されます。 |
| 共有アクセス許可を取得する |
この操作は、SharePoint Embedded コンテナー内のファイルに対する特定の共有アクセス許可を取得します。 |
| 共有リンクを作成する |
この操作により、SharePoint Embedded コンテナー内のファイルの共有リンクが作成されます。 |
コンテナの削除
コンテナーを削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
コンテナーのアクセス許可を一覧表示する
コンテナーに対するアクセス許可を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
戻り値
コンテナーのアクセス許可を削除する
コンテナーに対するアクセス許可を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
アクセス許可 ID
|
permission-id | True | string |
アクセス許可 ID |
コンテナーのアクセス許可を更新する
コンテナーのアクセス許可を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
アクセス許可 ID
|
permission-id | True | string |
アクセス許可 ID |
|
アクセス許可ロール
|
roles | True | array of string |
ユーザーに付与するロール |
戻り値
コンテナーのアクティブ化
コンテナーをアクティブ化する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
コンテナーのカスタム プロパティを取得する
コンテナーのカスタム プロパティを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
戻り値
コンテナーのカスタム プロパティを更新する
コンテナーのカスタム プロパティを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
|
object |
戻り値
コンテナーの一覧表示
コンテナーの一覧表示
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナーの種類 ID
|
containerType | True | string |
指定したコンテナーの種類のコンテナーを一覧表示する |
戻り値
コンテナーの作成アクセス許可
コンテナーに対するアクセス許可を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
アクセス許可ロール
|
roles | True | array of string |
ユーザーに付与するロール |
|
ユーザー プリンシパル名
|
userPrincipalName | True | string |
ID ユーザー プリンシパル名 |
戻り値
コンテナーの取得
コンテナーの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
戻り値
- Body
- FileStorageContainer
コンテナーを更新する
コンテナーを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
Description
|
description | string |
コンテナーの説明 |
|
|
表示される名前
|
displayName | string |
コンテナーの名前 |
|
|
OCR が有効
|
isOcrEnabled | boolean |
コンテナーに対して OCR (光学式文字認識) が有効になっているかどうか |
|
|
アイテムのマイナー バージョン制限
|
itemMinorVersionLimit | integer |
コンテナー内の項目に保持するマイナー バージョンの最大数 |
|
|
項目のバージョン管理が有効
|
isItemVersioningEnabled | boolean |
コンテナーに対して項目のバージョン管理が有効になっているかどうか |
戻り値
- Body
- FileStorageContainer
コンテナー内のアイテムを一覧表示する
この操作では、コンテナー内のファイルとサブフォルダーの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
親フォルダー ID
|
parentId | True | string |
アイテムを一覧表示する親フォルダーの ID。 'root' を使用してコンテナーのルート レベルから項目を取得するか、特定のフォルダー ID を指定してそのフォルダーからアイテムを取得します |
|
Filter
|
$filter | string |
結果のフィルター条件 (OData 形式) 例: parentReference/id eq '{{folderId}}' AND contains(listitem/fields/FileLeafRef, {{user_name_string}}) |
|
|
選択する
|
$select | string |
結果に含めるプロパティ (コンマ区切り) |
|
|
展開
|
$expand | string |
応答で拡張する関連リソース |
|
|
上
|
$top | integer |
返される結果の数 |
|
|
並べ替え
|
$orderby | string |
結果を並べ替えるフィールドと方向 |
戻り値
ドライブ項目のページを表します。
コンテナー列の作成
コンテナーのスキーマを定義する列を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
|
object |
戻り値
コンテナー列の削除
コンテナーのスキーマを定義する列を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
列 ID
|
column-id | True | string |
列 ID |
コンテナー列を一覧表示する
コンテナーのスキーマを定義する列を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
Filter
|
$filter | string |
結果に適用するフィルター |
戻り値
コンテナー列を取得する
コンテナーの列を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
|
列 ID
|
column-id | True | string |
列 ID |
戻り値
サムネイルを一覧表示する
この操作では、SharePoint Embedded コンテナー内のファイルで使用可能なサムネイルが一覧表示されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
戻り値
サムネイル セットのコレクションを表します
- Body
- ThumbnailSets
サムネイルを取得する
この操作では、SharePoint Embedded コンテナー内のファイルの特定のサムネイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
サムネイル ID
|
thumbnail-id | True | string |
サムネイル セットの一意識別子 |
|
サイズ
|
size | True | string |
取得するサムネイルのサイズ |
戻り値
1 つのサムネイルを表します
- Body
- Thumbnail
チェック アウトを破棄
この操作により、SharePoint Embedded コンテナー内のファイルからチェックアウトが破棄されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
ファイル バージョンの削除
この操作により、SharePoint Embedded コンテナー内の特定のバージョンのファイルが削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
バージョン ID
|
version-id | True | string |
削除するバージョンの一意識別子 |
ファイル フィールドを一覧表示する
この操作では、SharePoint Embedded コンテナー内のファイルに関連付けられているリスト アイテム フィールド (メタデータ) を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
フィールドの ETag 値 |
ファイル フィールドを設定する
この操作により、SharePoint Embedded コンテナー内のファイルに関連付けられているリスト アイテム フィールド (メタデータ) が更新されます。 null 値を使用してフィールド値をクリアします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
|
object |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
フィールドの ETag 値 |
ファイルのチェックイン
この操作は、SharePoint Embedded コンテナーでチェックアウトされたファイルをチェックインします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
コメント
|
comment | string |
バージョンに関連付けられているチェックイン コメント |
|
|
[次のユーザーとしてチェックイン]
|
checkInAs | string |
チェックイン後のドキュメントの状態 (公開または未成年) |
ファイルのバージョンを一覧表示する
この操作では、SharePoint Embedded コンテナー内のファイルの以前のバージョンが一覧表示されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
戻り値
ファイル バージョンのコレクションを表します
- Body
- FileVersions
ファイルのバージョンを取得する
この操作では、SharePoint Embedded コンテナー内のファイルの特定のバージョンを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
バージョン ID
|
version-id | True | string |
バージョンの一意識別子 |
戻り値
ファイルのバージョンを表します
- Body
- FileVersion
ファイルのプレビューを作成する
この操作により、SharePoint Embedded コンテナー内のファイルのプレビューが作成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
ページ
|
page | integer |
プレビューするドキュメントのページ番号を指定します。 |
|
|
ズーム レベル
|
zoom | float |
ドキュメント プレビューのズーム レベルを指定します (例: 0.5、1.0、1.5) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
URL を取得する
|
getUrl | string |
GET 要求を使用してプレビューを取得するために使用できる URL |
|
Post パラメーター
|
postParameters | string |
postUrl プロパティと共に使用して POST 要求を使用してプレビューを取得できるパラメーター |
|
投稿 URL
|
postUrl | string |
POST 要求を使用してプレビューを取得するために使用できる URL |
ファイルのプロパティの取得
この操作では、SharePoint Embedded コンテナー内のファイルのプロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
戻り値
ドライブ項目のメタデータ
- Body
- DriveItem
ファイルの内容を取得する
この操作は、ファイルの内容を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
ファイルの内容を更新する
この操作により、ファイルの内容が更新されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル コンテンツ (Base64)
|
body | True | byte |
Base64 でエンコードされたファイルの内容 |
戻り値
ファイルの内容
- ファイルの内容
- binary
ファイルをチェックアウトする
この操作により、SharePoint Embedded コンテナー内のファイルがチェックアウトされ、他のユーザーがドキュメントを編集できなくなります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
ファイルを作成する
この操作により、ファイルが作成され、driveItem のメタデータが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親 ID
|
parent-id | True | string |
親フォルダーまたは 'root' のドライブ項目 ID |
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル名
|
file-name | True | string |
ファイルの名前 |
|
ファイル コンテンツ (Base64)
|
body | True | byte |
Base64 でエンコードされたファイルの内容 |
戻り値
ドライブ項目のメタデータ
- Body
- DriveItem
ファイルを削除する
この操作により、SharePoint Embedded コンテナー内のファイルが削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
ファイル名の変更
この操作により、SharePoint Embedded コンテナー内のファイルの名前が変更されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
名前
|
name | string |
ファイルの新しい名前 |
戻り値
ドライブ項目のメタデータ
- Body
- DriveItem
フォルダーを作成する
この操作により、ルート レベルまたは別のフォルダー内の SharePoint Embedded コンテナーに新しいフォルダーが作成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
親フォルダー ID
|
parent-id | True | string |
新しいフォルダーが作成される親フォルダーの ID。 'root' を使用してコンテナーのルート レベルでフォルダーを作成するか、入れ子になったフォルダーを作成するための特定のフォルダー ID を指定します。 |
|
フォルダー名
|
name | True | string |
作成するフォルダーの名前 |
|
競合の動作
|
@microsoft.graph.conflictBehavior | string |
同じ名前のフォルダーが既に存在する場合の対処方法 |
戻り値
ドライブ項目のメタデータ
- Body
- DriveItem
リサイクルされたアイテムを一覧表示する
この操作では、SharePoint埋め込みコンテナーのごみ箱内のアイテムが一覧表示されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
戻り値
ごみ箱内のアイテムのコレクション
リサイクルされたアイテムを削除する
この操作により、SharePoint埋め込みコンテナーのごみ箱から 1 つ以上のリサイクル済みアイテムが完全に削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
アイテム ID
|
ids | True | array of string |
完全に削除するリサイクルされた項目 ID の配列 |
リサイクルされたアイテムを復元する
この操作により、SharePoint埋め込みコンテナーのごみ箱から 1 つ以上のリサイクルされたアイテムが復元されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
アイテム ID
|
ids | True | array of string |
復元するリサイクルされた項目 ID の配列 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
アイテム ID
|
value.id | string |
復元された項目の ID |
リサイクルされたコンテナーを一覧表示する
リサイクルされたコンテナーを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナーの種類 ID
|
containerType | True | string |
指定したコンテナーの種類のリサイクルされたコンテナーを一覧表示する |
戻り値
リサイクルされたコンテナーを削除する
リサイクルされたコンテナーを完全に削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
リサイクルされたコンテナーを復元する
リサイクルされたコンテナーを復元する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナー ID |
戻り値
- Body
- FileStorageContainer
リスト アイテムの共有アクセス許可
この操作では、SharePoint Embedded コンテナー内のアイテムの共有アクセス許可が一覧表示されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
アイテム ID
|
file-id | True | string |
アイテムの一意識別子 |
戻り値
ファイルまたはフォルダーのアクセス許可の一覧を表します
共有の招待を送信する
この操作により、SharePoint Embedded コンテナー内のファイルの共有の招待が送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
サインインが必要
|
requireSignIn | True | boolean |
招待の受信者がサインインして共有アイテムを表示する必要があるかどうかを示します |
|
役割
|
roles | True | array of string |
共有の招待の受信者に付与されるアクセス許可 |
|
Email
|
string |
受信者のメール アドレス |
||
|
エイリアス
|
alias | string |
受信者のエイリアス (Microsoft 365受信者の場合) |
|
|
オブジェクト ID
|
objectId | string |
Azure Active Directoryの受信者の一意識別子 |
|
|
メッセージ
|
message | True | string |
共有の招待の一部として送信されたカスタム メッセージ |
|
招待状の送信
|
sendInvitation | True | boolean |
true の場合、共有リンクが受信者に送信されます。 false の場合、アクセス許可は作成されますが、招待メッセージは送信されません。 |
戻り値
ファイルまたはフォルダーのアクセス許可の一覧を表します
共有アクセス許可を削除する
この操作により、SharePoint Embedded コンテナー内のファイルに対する特定の共有アクセス許可が削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
アクセス許可 ID
|
permission-id | True | string |
削除するアクセス許可の一意識別子 |
共有アクセス許可を取得する
この操作は、SharePoint Embedded コンテナー内のファイルに対する特定の共有アクセス許可を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
アクセス許可 ID
|
permission-id | True | string |
アクセス許可の一意識別子 |
戻り値
ファイルまたはフォルダーのアクセス許可を表します
共有リンクを作成する
この操作により、SharePoint Embedded コンテナー内のファイルの共有リンクが作成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
コンテナーの一意識別子 |
|
ファイル ID
|
file-id | True | string |
ファイルの一意識別子 |
|
リンクの種類
|
type | True | string |
作成する共有リンクの種類。 |
|
リンク スコープ
|
scope | string |
共有リンクのスコープ |
|
|
有効期限
|
expirationDateTime | date-time |
リンクの有効期限が切れる日時 (yyyy-MM-ddTHH:mm:ssZ) |
戻り値
ファイルまたはフォルダーの共有リンクを表します
- Body
- SharingLink
トリガー
| コンテナー内の項目の変更を監視する |
SharePoint Embedded コンテナーで項目が追加、変更、または削除されたときにトリガーされます |
コンテナー内の項目の変更を監視する
SharePoint Embedded コンテナーで項目が追加、変更、または削除されたときにトリガーされます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
container-id | True | string |
監視するコンテナーの ID |
|
ポーリング間隔 (秒)
|
pollingInterval | integer |
変更を確認する頻度 (60 ~ 3600 秒、既定値: 300) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of DriveItem |
変更されたアイテムの一覧 |
|
@odata.deltaLink
|
@odata.deltaLink | string |
次のポーリング要求の差分リンク |
|
@odata.context
|
@odata.context | string |
@odata.context |
定義
FileStorageContainer
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテナー ID
|
id | string |
コンテナー ID |
|
コンテナーの種類 ID
|
containerTypeId | string |
このコンテナーが属するコンテナーの種類の ID |
|
Description
|
description | string |
コンテナーの説明 |
|
表示される名前
|
displayName | string |
コンテナーの名前 |
|
作成時刻
|
createdDateTime | date-time |
コンテナーの作成日時 |
|
customProperties
|
customProperties | FileStorageContainer.CustomProperties | |
|
アクセス許可
|
permissions | FileStorageContainer.Permissions | |
|
状態
|
status | string |
コンテナーの状態 |
FileStorageContainer.List
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of FileStorageContainer |
FileStorageContainer.Permissions
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
FileStorageContainer.Permission |
FileStorageContainer.Permission
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アクセス許可 ID
|
id | string |
アクセス許可 ID |
|
アクセス許可ロール
|
roles | FileStorageContainer.Permission.Roles |
ユーザーに付与するロール |
|
表示される名前
|
grantedToV2.user.displayName | string |
ID の表示名 |
|
Email
|
grantedToV2.user.email | string |
ID メール |
|
ユーザー プリンシパル名
|
grantedToV2.user.userPrincipalName | string |
ID ユーザー プリンシパル名 |
FileStorageContainer.Permission.Roles
ユーザーに付与するロール
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
string |
FileStorageContainer.Permissions.List
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | FileStorageContainer.Permissions |
FileStorageContainer.CustomProperties
FileStorageContainer.Column
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
列 ID
|
id | string |
列の一意識別子 |
|
列名
|
name | string |
列の表示名 |
|
Description
|
description | string |
列の説明 |
|
一意の値を適用する
|
enforceUniqueValues | boolean |
列の値を一意にする必要があるかどうか |
|
隠れた
|
hidden | boolean |
列が UI に表示されるかどうか |
|
インデックス付き
|
indexed | boolean |
列のインデックスが作成されるかどうか |
|
必須
|
required | boolean |
列が必要かどうか |
|
[読み取り専用]
|
readOnly | boolean |
列の値を変更できるかどうか |
|
列グループ
|
columnGroup | string |
この列が属するグループ |
|
表示される名前
|
displayName | string |
列の表示名 |
|
削除可能
|
isDeletable | boolean |
この列を削除できるかどうかを示します。 |
|
並べ替え可能
|
isReorderable | boolean |
この列を並べ替えることができるかどうかを示します。 |
|
シールされている
|
isSealed | boolean |
列を変更できるかどうかを指定します。 |
|
変更を反映する
|
propagateChanges | boolean |
true の場合、この列に対する変更は、列を実装するリストに反映されます。 |
|
既定値列 - 数式
|
defaultValue.formula | string |
列の既定値を計算するために使用する数式。 |
|
既定値列 - 値
|
defaultValue.value | string |
列の既定値として使用する直接値。 |
|
テキスト列 - 最大長
|
text.maxLength | integer |
テキストの最大長 |
|
テキスト列 - 複数行を許可
|
text.allowMultipleLines | boolean |
複数行のテキストを許可するかどうか |
|
テキスト列 - 変更の追加
|
text.appendChangesToExistingText | boolean |
この列の更新を既存のテキストに追加するかどうか |
|
テキスト列 - 編集用の行
|
text.linesForEditing | integer |
編集コントロールに表示するテキストの行数 |
|
テキスト列 - テキスト型
|
text.textType | string |
保存するテキストの種類 |
|
数値列 - 小数点以下の桁数
|
number.decimalPlaces | string |
表示する小数点以下の桁数 |
|
数値列 - 表示
|
number.displayAs | string |
番号を表示する方法 |
|
Number Column - Maximum
|
number.maximum | number |
最大許容値 |
|
数値列 - 最小
|
number.minimum | number |
許容される最小値 |
|
ブーリアン
|
boolean | object |
ブール型列の設定 |
|
DateTime 列 - 表示形式
|
dateTime.displayAs | string |
日付と時刻を表示する方法 |
|
DateTime 列 - 書式
|
dateTime.format | string |
日付に時刻を含めるかどうか |
|
選択肢列 - テキスト入力を許可
|
choice.allowTextEntry | boolean |
カスタム値を入力できるかどうか |
|
選択肢列 - 選択肢
|
choice.choices | array of string |
列の選択肢の一覧 |
|
選択肢列 - 表示
|
choice.displayAs | string |
選択肢を表示する方法 |
|
ルックアップ列 - 複数の値を許可する
|
lookup.allowMultipleValues | boolean |
複数の値を選択できるかどうか |
|
ルックアップ列 - 無制限の長さを許可する
|
lookup.allowUnlimitedLength | boolean |
列の値が標準の 255 文字を超えることができるかどうか。 |
|
ルックアップ列 - リスト ID
|
lookup.listId | string |
このルックアップが取得するリストの ID |
|
ルックアップ列 - プライマリ参照列 ID
|
lookup.primaryLookupColumnId | string |
情報を取得する列の ID |
|
通貨列 - ロケール
|
currency.locale | string |
通貨のロケール |
|
PersonOrGroup 列 - 複数選択を許可する
|
personOrGroup.allowMultipleSelection | boolean |
複数のユーザーまたはグループを選択できるかどうか |
|
PersonOrGroup 列 - 種類から選択
|
personOrGroup.chooseFromType | string |
選択できるユーザーまたはグループの種類 |
|
PersonOrGroup 列 - 表示名
|
personOrGroup.displayAs | string |
ユーザーまたはグループを表示する方法 |
|
HyperlinkOrPicture 列 - 図
|
hyperlinkOrPicture.isPicture | boolean |
ハイパーリンクが画像かどうか |
|
計算列 - 数式
|
calculated.formula | string |
計算の数式 |
|
計算列 - 出力の種類
|
calculated.outputType | string |
出力の種類 |
|
計算列 - 書式
|
calculated.format | string |
日付に時刻を含めるかどうか |
|
地理位置情報列
|
geolocation | object |
場所列の設定 |
|
サムネイル列のプロパティ
|
thumbnail | object |
サムネイル列の設定 |
|
コンテンツ承認ステータス列のプロパティ
|
contentApprovalStatus | object |
この列には、コンテンツ承認の状態が格納されます。 |
|
用語列 - 複数の値を許可する
|
term.allowMultipleValues | boolean |
複数の値を選択できるかどうか |
|
用語列 - 完全修飾名の表示
|
term.showFullyQualifiedName | boolean |
用語パス全体を表示するか、用語ラベルのみを表示するかを指定します。 |
|
コンテンツ タイプ ID
|
sourceContentType.id | string |
コンテンツ タイプの ID。 |
|
コンテンツ タイプ名
|
sourceContentType.name | string |
コンテンツ タイプの名前。 |
FileStorageContainer.Columns.List
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of FileStorageContainer.Column |
DriveItemCollectionPage
ドライブ項目のページを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of DriveItem |
ドライブ項目のコレクション。 |
|
@odata.nextLink
|
@odata.nextLink | string |
次のページを取得するために使用できる URL。 |
DriveItem
ドライブ項目のメタデータ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
URL のダウンロード
|
@microsoft.graph.downloadUrl | string |
このアイテムのコンテンツをダウンロードするために使用できる URL |
|
URL のダウンロード (認証なし)
|
@microsoft.graph.downloadUrlNoAuth | string |
認証なしでこのアイテムのコンテンツをダウンロードするために使用できる URL |
|
ID
|
id | string |
ファイルまたはフォルダーの一意識別子 |
|
名前
|
name | string |
ファイルまたはフォルダーの名前 |
|
サイズ
|
size | integer |
ファイルまたはフォルダーのサイズ (バイト単位) |
|
Web URL
|
webUrl | string |
ブラウザーにアイテムを表示する URL |
|
作成時刻
|
createdDateTime | date-time |
ファイルまたはフォルダーが作成された日時 |
|
最終修正日時
|
lastModifiedDateTime | date-time |
ファイルまたはフォルダーが最後に変更された日時 |
|
ETag
|
eTag | string |
ファイルまたはフォルダーの etag |
|
CTag
|
cTag | string |
コンテンツが変更されたことを示すタグ |
|
ドライブ タイプ
|
parentReference.driveType | string |
項目を含むドライブの種類 |
|
ドライブ ID
|
parentReference.driveId | string |
項目を含むドライブの ID |
|
親 ID
|
parentReference.id | string |
親フォルダーの ID |
|
親名
|
parentReference.name | string |
親フォルダーの名前 |
|
親パス
|
parentReference.path | string |
親フォルダーへのパス |
|
サイト ID
|
parentReference.siteId | string |
アイテムを含むサイトの ID |
|
アプリケーション識別子
|
createdBy.application.id | string |
アイテムを作成したアプリケーションの ID |
|
アプリケーション名
|
createdBy.application.displayName | string |
アイテムを作成したアプリケーションの表示名 |
|
ユーザーID
|
createdBy.user.id | string |
アイテムを作成したユーザーの ID |
|
ユーザー名
|
createdBy.user.displayName | string |
アイテムを作成したユーザーの表示名 |
|
アプリケーション識別子
|
lastModifiedBy.application.id | string |
アイテムを最後に変更したアプリケーションの ID |
|
アプリケーション名
|
lastModifiedBy.application.displayName | string |
アイテムを最後に変更したアプリケーションの表示名 |
|
ユーザーID
|
lastModifiedBy.user.id | string |
アイテムを最後に変更したユーザーの ID |
|
ユーザー名
|
lastModifiedBy.user.displayName | string |
アイテムを最後に変更したユーザーの表示名 |
|
MIME の種類
|
file.mimeType | string |
ファイルの MIME の種類 |
|
QuickXor ハッシュ
|
file.hashes.quickXorHash | string |
ファイルの QuickXor ハッシュ |
|
作成時刻
|
fileSystemInfo.createdDateTime | date-time |
ファイル システムでファイルまたはフォルダーが作成された日時 |
|
最終修正日時
|
fileSystemInfo.lastModifiedDateTime | date-time |
ファイル システムでファイルまたはフォルダーが最後に変更された日時 |
|
子カウント
|
folder.childCount | integer |
フォルダー内のアイテムの数 |
|
共有スコープ
|
shared.scope | string |
共有のスコープ (ユーザー、組織、またはすべてのユーザー) |
SharingLink
ファイルまたはフォルダーの共有リンクを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リンク ID
|
id | string |
共有リンクの一意識別子 |
|
リンクの種類
|
link.type | string |
共有リンクの種類 (表示、編集、埋め込み) |
|
リンク スコープ
|
link.scope | string |
共有リンクのスコープ |
|
Web URL
|
link.webUrl | string |
共有リンクの URL |
|
ディスプレイ名
|
link.application.displayName | string |
アプリケーションの表示名 |
|
id
|
link.application.id | string |
アプリケーションの一意識別子 |
SharingPermissionResponse
ファイルまたはフォルダーのアクセス許可を表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アクセス許可 ID
|
id | string |
アクセス許可の一意識別子 |
|
役割
|
roles | array of string |
このアクセス許可に付与されたロール |
|
共有 ID
|
shareId | string |
共有 API を介してこの共有アイテムにアクセスするために使用できる一意のトークン |
|
表示される名前
|
grantedTo.user.displayName | string |
ユーザーの表示名 |
|
Email
|
grantedTo.user.email | string |
ユーザーの電子メール アドレス |
|
ユーザーID
|
grantedTo.user.id | string |
ユーザーの一意識別子 |
|
リンク スコープ
|
link.scope | string |
リンクのスコープ |
|
リンクの種類
|
link.type | string |
リンクの種類 |
|
Web URL
|
link.webUrl | string |
リンクの URL |
|
Email
|
invitation.email | string |
招待が送信された電子メール アドレス |
|
サインインが必要
|
invitation.signInRequired | boolean |
共有アイテムにアクセスするためにサインインが必要かどうか |
|
有効期限の日時
|
expirationDateTime | date-time |
アクセス許可の有効期限が切れる日時 |
|
ID に付与
|
grantedToIdentities | array of object |
指定した場合、共有は一覧表示されているユーザーのみに制限されます |
|
表示される名前
|
grantedToIdentities.user.displayName | string |
ユーザーの表示名 |
|
Email
|
grantedToIdentities.user.email | string |
ユーザーの電子メール アドレス |
|
ユーザーID
|
grantedToIdentities.user.id | string |
ユーザーの一意識別子 |
SharingPermissionsList
ファイルまたはフォルダーのアクセス許可の一覧を表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of SharingPermissionResponse |
FileVersion
ファイルのバージョンを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バージョン ID
|
id | string |
バージョンの ID |
|
[変更者]
|
lastModifiedBy.user.displayName | string |
バージョンを変更したユーザーの名前 |
|
ユーザーID
|
lastModifiedBy.user.id | string |
バージョンを変更したユーザーの ID |
|
更新日時
|
lastModifiedDateTime | date-time |
このバージョンが最後に変更された日時 |
|
サイズ
|
size | integer |
バージョンのサイズ (バイト単位) |
|
パブリケーション レベル
|
publication.level | string |
このバージョンのパブリケーション レベル (発行済みまたはチェックアウト) |
|
バージョン ID
|
publication.versionId | string |
公開されているバージョンの ID |
FileVersions
ファイル バージョンのコレクションを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of FileVersion |
ファイル バージョンのコレクション |
ThumbnailSet
ファイルのサムネイルのセットを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サムネイル セット ID
|
id | string |
サムネイル セットの一意識別子 |
|
大
|
large | Thumbnail |
1 つのサムネイルを表します |
|
中間
|
medium | Thumbnail |
1 つのサムネイルを表します |
|
小さい
|
small | Thumbnail |
1 つのサムネイルを表します |
|
ソース
|
source | Thumbnail |
1 つのサムネイルを表します |
サムネイル
1 つのサムネイルを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
高さ
|
height | integer |
サムネイルの高さ (ピクセル単位) |
|
Width
|
width | integer |
サムネイルの幅 (ピクセル単位) |
|
URL
|
url | string |
サムネイルの URL |
ThumbnailSets
サムネイル セットのコレクションを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of ThumbnailSet |
サムネイル セットのコレクション |
RecycleBinItem
ごみ箱内のアイテムを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
リサイクルされた項目の一意の識別子 |
|
名前
|
name | string |
リサイクルされた項目の名前 |
|
サイズ
|
size | integer |
項目のサイズ (バイト単位) |
|
削除日
|
deletedDateTime | date-time |
アイテムが削除された日時 |
|
場所から削除
|
deletedFromLocation | string |
アイテムが最初に含まれていた場所の相対 URL |
|
Title
|
title | string |
リサイクルされたアイテムのタイトル |
|
削除者
|
deletedBy.user.displayName | string |
アイテムを削除したユーザーの表示名 |
|
Email
|
deletedBy.user.email | string |
アイテムを削除したユーザーの電子メール |
|
ユーザーID
|
deletedBy.user.id | string |
アイテムを削除したユーザーの一意識別子 |
RecycleBinItemCollection
ごみ箱内のアイテムのコレクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of RecycleBinItem |
ごみ箱内のアイテムのコレクション |
binary
これは基本的なデータ型 'binary' です。