DriveItem リソース型
名前空間: microsoft.graph
driveItem リソースは、ドライブに格納されているファイル、フォルダーなどのアイテムを表します。
OneDrive および SharePoint 内のすべてのファイル システム オブジェクトが、driveItem リソースとして返されます。 SharePoint のドキュメント ライブラリにあるアイテムは、llistItemまたはdriveItem リソースとして表すことができます。
driveItem リソースのアドレス指定には、主に 2 つの方法があります。
-
drive/items/{item-id}を使用した、driveItem 一意識別子による方法 -
/drive/root:/path/to/fileを使用した、ファイル システム パスによる方法
詳細については、「driveItems のアドレス指定」を参照してください。
DriveItem リソースには、driveItem の ID および機能に関するデータを提供するプロパティとしてモデル化されたファセットがあります。 次に例を示します。
- フォルダーにはフォルダー ファセットがあります
- ファイルには ファイル ファセットがあります。
- イメージには、ファイル ファセットに加えて イメージ ファセットがあります。
- カメラで撮影した画像 (写真) には写真ファセットがあります。写真ファセットは、アイテムを写真として識別し、撮影日時と撮影デバイスのプロパティを提供します。
フォルダー ファセットを持つアイテムは、アイテムのコンテナーとして機能するため、フォルダーに含まれる driveItems のコレクションを指す children 参照を持ちます。
メモ：OneDrive for Businessまたは SharePoint ドキュメント ライブラリでは、driveItem にフォルダー ファセットがある場合、cTag プロパティは返されません。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| アイテムを取得する | driveItem | ドライブ内の driveItem のメタデータを取得します。 |
| 分析を取得する | itemAnalytics | このリソースの分析を取得します。 |
| 間隔ごとにアクティビティを取得する | itemActivityStat | 指定した時間間隔内にitemActivityStatsのコレクションを取得します。 |
| 子を一覧表示する | driveItem コレクション | driveItem の子関係にある driveItems のコレクションを返します。 |
| バージョンを一覧表示する | driveItemVersion コレクション | 現在のユーザーのドライブ内のファイルのバージョンを取得します。 |
| フォルダーを作成する | driveItem | 指定したドライブ内の driveItem をCreateします。 |
| アイテムを更新する | driveItem | ドライブ内の driveItem を更新します。 |
| アップロード | driveItem | driveItem にコンテンツをアップロードします。 |
| ファイルをダウンロードする | ダウンロード URL | driveItem のコンテンツをダウンロードします。 |
| 特定のファイル形式をダウンロードする | ダウンロード URL | 特定の形式の driveItem のコンテンツをダウンロードします。 |
| アイテムを削除する | なし | driveItem を削除します。 |
| アイテムを完全に削除する | なし | ID を使用して driveItem を 完全に削除します。 |
| アイテムを移動する | driveItem | driveItem を新しい親項目に移動します。 |
| アイテムをコピーする | コピーの進行状況を監視する方法についての詳細 | driveItem (子を含む) のコピーをCreateします。 |
| アイテムを検索する | driveItem コレクション | クエリと一致するアイテムを対象にアイテムの階層を検索します。 |
| 変更履歴の記録 | 差分リンク | ドライブでのすべての変更を一覧表示します。 |
| アイテムをフォローする | driveItem | driveItem に従います。 |
| アイテムのフォローを解除する | なし | driveItem のフォローを解除します。 |
| サムネイルを取得する | driveItem コレクション | サムネイルを含む driveItems を一覧表示します。 |
| 共有リンクを作成する | 共有リンク | driveItem を共有するリンクをCreateします。 |
| アクセス許可を追加する | permission コレクション | ユーザーに共有の招待を送信します。 |
| アクセス許可を一覧表示する | permission コレクション | driveItem に対するアクセス許可のコレクションを取得します。 |
| アクセス許可を削除する | なし | driveItem からアクセス許可を削除します。 |
| WebSocket チャネルを取得する | subscription | socket.io を使用して、ドライブのほぼリアルタイムの変更通知を受け取ります。 |
| アイテムをプレビューする | JSON オブジェクト | 一時的なプレビューを表示するために、アイテムの、有効期限が短い埋め込み可能な URL を取得します。 |
| ファイルをチェックインする | なし | チェックアウトされた driveItem リソースをチェックインします。これにより、ドキュメントのバージョンを他のユーザーが使用できるようになります。 |
| ファイルをチェックアウトする | なし | driveItem リソースをチェックアウトして、他のユーザーがドキュメントを編集できないようにし、ドキュメントがチェックインされるまで変更が表示されないようにします。 |
| 秘密度ラベルを抽出する | extractSensitivityLabelsResult | ドライブ項目に割り当てられた 1 つ以上の秘密度ラベルを抽出し、割り当てられたラベルの最新の詳細でドライブ項目のメタデータを更新します。 |
| 秘密度ラベルを割り当てる | String | driveItem に秘密度ラベルを非同期的に割り当てます。 |
| 保持ラベルを取得する | itemRetentionLabel | driveItem に適用された保持ラベルのメタデータ情報を取得します。 |
| 保持ラベルを設定する | itemRetentionLabel | driveItem (ファイルとフォルダー) に保持ラベルを適用 (設定) します。 |
| 保持ラベルを削除する | なし | driveItem から保持ラベルを削除します。 |
| レコードをロックまたはロック解除する | itemRetentionLabel | コンテンツをレコードとして分類する driveItem の保持ラベルをロックまたはロック解除します。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| audio | audio | オーディオのメタデータ (アイテムがオーディオ ファイルである場合)。 読み取り専用です。 読み取り専用です。 OneDrive 個人用においてのみ。 |
| バンドル | バンドル | バンドル メタデータ (アイテムがバンドルである場合)。 読み取り専用です。 |
| content | Stream | コンテンツのストリーム (アイテムがファイルを表す場合)。 |
| createdBy | identitySet | アイテムを作成したユーザー、デバイス、アプリケーションの ID。 読み取り専用です。 |
| createdDateTime | DateTimeOffset | アイテム作成の日時。 読み取り専用です。 |
| cTag | String | アイテムのコンテンツの eTag。 メタデータのみが変更された場合、この eTag は変更されません。 メモ アイテムがフォルダーの場合、このプロパティは返されません。 読み取り専用です。 |
| deleted | deleted | アイテムの削除状態に関する情報。 読み取り専用です。 |
| 説明 | String | ユーザーに表示されるアイテムの説明を提供します。 読み取り/書き込み。 OneDrive 個人用においてのみ。 |
| eTag | String | アイテム全体 (メタデータおよびコンテンツ) の eTag。 読み取り専用です。 |
| file | file | ファイルのメタデータ (アイテムがファイルである場合)。 読み取り専用です。 |
| fileSystemInfo | fileSystemInfo | クライアント上のファイル システム情報。 読み取り/書き込み。 |
| folder | folder | フォルダーのメタデータ (アイテムがフォルダーである場合)。 読み取り専用です。 |
| id | String | ドライブ内のアイテムの一意識別子。 読み取り専用です。 |
| image | image | 画像のメタデータ (アイテムが画像である場合)。 読み取り専用です。 |
| lastModifiedBy | identitySet | アイテムを最後に変更したユーザー、デバイス、アプリケーションの ID。 読み取り専用です。 |
| lastModifiedDateTime | DateTimeOffset | アイテムが最後に変更された日時。 読み取り専用です。 |
| location | geoCoordinates | 場所のメタデータ (アイテムに場所データが含まれている場合)。 読み取り専用です。 |
| マルウェア | マルウェア | アイテムにマルウェアが含まれていることが検出された場合のマルウェア メタデータ。 読み取り専用。 |
| name | String | アイテムの名前 (ファイル名と拡張子)。 読み取り/書き込み。 |
| package | package | これがある場合、アイテムはフォルダーやファイルではなく、パッケージです。 パッケージは、コンテキスト次第で、ファイルとして、あるいはフォルダーとして扱われます。 読み取り専用です。 |
| parentReference | itemReference | 親の情報 (アイテムに親がある場合)。 読み取り/書き込み。 |
| pendingOperations | pendingOperations | 存在する場合、driveItemの状態に影響する可能性のある1つまたは複数の操作が完了保留中であることを示します。 読み取り専用です。 |
| photo | photo | 写真のメタデータ (アイテムが写真である場合)。 読み取り専用です。 |
| publication | publicationFacet | アイテムが公開されているか、チェックアウトの状態かどうかの情報を、そのような操作をサポートする場所で提供します。 このプロパティは既定では返されません。 読み取り専用です。 |
| remoteItem | remoteItem | リモート アイテムのデータ (現在アクセス中のドライブ以外のドライブから共有されているアイテムの場合)。 読み取り専用です。 |
| root | root | このプロパティが null ではない場合は、driveItem がドライブで最上位の driveItem であることを示します。 |
| searchResult | searchResult | 検索のメタデータ (検索結果に由来するアイテムの場合)。 読み取り専用です。 |
| shared | shared | アイテムが他のユーザーと共有されたことを示し、アイテムの共有状態に関する情報を提供します。 読み取り専用。 |
| sharepointIds | sharepointIds | SharePoint REST 互換性に役立つ識別子を返します。 読み取り専用です。 |
| size | Int64 | アイテムのサイズ (バイト単位)。 読み取り専用です。 |
| specialFolder | specialFolder | 現在のアイテムが特別なフォルダーとしても使用可能な場合は、このファセットが返されます。 読み取り専用です。 |
| video | video | ビデオのメタデータ (アイテムがビデオである場合)。 読み取り専用。 |
| webDavUrl | String | アイテムの WebDAV 互換性のある URL。 |
| webUrl | String | ブラウザーでリソースを表示するための URL。 読み取り専用です。 |
注: eTag プロパティと cTag プロパティは、コンテナー (フォルダー) 上での機能が異なります。 cTag 値は、フォルダーのいずれかの子孫のコンテンツまたはメタデータが変更されると変更されます。 eTag 値は、子孫から派生したプロパティ (childCount や lastModifiedDateTime など) 以外のフォルダーのプロパティが変更されたときにのみ、変更されます。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| アクティビティ | itemActivity コレクション | このアイテムに対して行われた最近のアクティビティのリストです。 |
| 分析 | itemAnalytics リソース | このアイテムについて行われたビュー アクティビティに関する分析。 |
| children | driveItem コレクション | アイテムの直接の子のアイテム オブジェクトを格納するコレクション。 子が含まれるのは、フォルダーを表すアイテムのみです。 読み取り専用です。 Null 許容型。 |
| createdByUser | user | アイテムを作成したユーザーの ID です。 読み取り専用です。 |
| lastModifiedByUser | user | アイテムを最後に変更したユーザーの ID です。 読み取り専用です。 |
| listItem | listItem | SharePoint のドライブの場合は、関連付けられているドキュメント ライブラリのリスト アイテム。 読み取り専用です。 Null 許容型。 |
| アクセス許可 | permission コレクション | アイテムのアクセス許可のセット。 読み取り専用です。 Null 許容型。 |
| retentionLabel | itemRetentionLabel | driveItem に適用される保持ラベルと設定に関する情報。 読み取り/書き込み。 |
| subscriptions | subscription コレクション | アイテムのサブスクリプションのセット。 ドライブのルートでのみサポートされています。 |
| thumbnails | thumbnailSet コレクション | アイテムに関連付けられている thumbnailSet オブジェクトのコレクション。 詳細については、「サムネイルの 取得」を参照してください。 読み取り専用です。 Null 許容型。 |
| versions | driveItemVersion コレクション | アイテムの以前のバージョンのリスト。 詳細については、「バージョンの一覧表示」を参照してください。 読み取り専用です。 Null 許容型。 |
| workbook | workbook | Excel スプレッドシートであるファイルの場合は、ブック API にアクセスしてスプレッドシートの内容を操作します。 Null 許容型。 |
インスタンスの属性
インスタンスの属性は、動作が特殊なプロパティです。 これらのプロパティは一時的なもので、サービスが実行する必要がある動作を定義するか、期限切れのアイテムのダウンロード URL などの短期的なプロパティ値を指定します。
| プロパティ名 | 種類 | 説明 |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | 新しいアイテムを作成するアクションの競合を解決する動作。 使用できる値は fail、replace、または rename です。 PUT の既定値は replace です。 この注釈を使用して項目が返されることはありません。 書き込み専用です。 |
| @microsoft.graph.downloadUrl | string | このファイルのコンテンツをダウンロードするために使用できる URL。 この URL では認証は必要ありません。 読み取り専用です。 |
| @microsoft.graph.sourceUrl | 文字列 | このインスタンス注釈を使用すると、PUT 要求を発行するときに URL の内容をダウンロードするようにサービスに指示し、ファイルとして格納できます。 書き込み専用です。 |
注: パラメーター
@microsoft.graph.conflictBehaviorは、要求の本文ではなく URL に含める必要があります。
@microsoft.graph.downloadUrlの値は短時間限定の URL であるため、キャッシュすることはできません。 URL は、短時間 (1 時間) の後に無効になります。 ユーザーのファイルへのアクセス許可を削除しても、すぐに URL が無効にならない可能性があります。ファイルのアップロードへの
@microsoft.graph.sourceUrlプロパティの使用は、OneDrive for Business、SharePoint Online および SharePoint Server 2016 ではサポートされていません。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
driveItem リソースは baseItem から派生し、そのリソースからプロパティを継承します。
{
"audio": { "@odata.type": "microsoft.graph.audio" },
"bundle": { "@odata.type": "microsoft.graph.bundle" },
"content": { "@odata.type": "Edm.Stream" },
"cTag": "string (etag)",
"deleted": { "@odata.type": "microsoft.graph.deleted"},
"description": "string",
"file": { "@odata.type": "microsoft.graph.file" },
"fileSystemInfo": { "@odata.type": "microsoft.graph.fileSystemInfo" },
"folder": { "@odata.type": "microsoft.graph.folder" },
"image": { "@odata.type": "microsoft.graph.image" },
"location": { "@odata.type": "microsoft.graph.geoCoordinates" },
"malware": { "@odata.type": "microsoft.graph.malware" },
"package": { "@odata.type": "microsoft.graph.package" },
"pendingOperations": { "@odata.type": "microsoft.graph.pendingOperations" },
"photo": { "@odata.type": "microsoft.graph.photo" },
"publication": {"@odata.type": "microsoft.graph.publicationFacet"},
"remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
"root": { "@odata.type": "microsoft.graph.root" },
"searchResult": { "@odata.type": "microsoft.graph.searchResult" },
"shared": { "@odata.type": "microsoft.graph.shared" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"size": 1024,
"specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
"video": { "@odata.type": "microsoft.graph.video" },
"webDavUrl": "string",
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"analytics": {"@odata.type": "microsoft.graph.itemAnalytics"},
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"createdByUser": { "@odata.type": "microsoft.graph.user" },
"retentionLabel": { "@odata.type": "microsoft.graph.itemRetentionLabel" },
"lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
"permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
"subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
"thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
"versions": [ {"@odata.type": "microsoft.graph.driveItemVersion"}],
/* inherited from baseItem */
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"eTag": "string",
"id": "string (identifier)",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"name": "string",
"parentReference": {"@odata.type": "microsoft.graph.itemReference"},
"webUrl": "string",
/* instance annotations */
"@microsoft.graph.conflictBehavior": "string",
"@microsoft.graph.downloadUrl": "url",
"@microsoft.graph.sourceUrl": "url"
}