DriveItem リソースの種類

DriveItem リソースは、ドライブ内のアイテムを表します。OneDrive 内のすべての最上位のファイル システム オブジェクトが、アイテム リソースとして返されます。

DriveItems へのアクセスは、id で (/items/{item-id} 構文を使用)、またはファイル システムのパスで (/drive/root:/path/to/file 構文を使用) 行えます。

アイテムには、アイテムの ID および機能に関するデータを提供するプロパティとしてモデル化されたファセットがあります。フォルダーにはフォルダー ファセットがあり、ファイルにはファイル ファセットがあります。画像にはファイル ファセットだけでなく、画像ファセットもあります。カメラで撮影した画像 (写真) には写真ファセットがあります。写真ファセットは、アイテムを写真として識別し、撮影日時と撮影デバイスのプロパティを提供します。

フォルダー ファセットを持つアイテムは、アイテムのコンテナーとして機能するため、フォルダーに含まれるアイテムのコレクションを指す children 参照を持ちます。

JSON 表記

以下は、リソースの JSON 表記です。

{
  "audio": {"@odata.type": "microsoft.graph.audio"},
  "cTag": "string",
  "content": "stream",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "deleted": {"@odata.type": "microsoft.graph.deleted"},
  "eTag": "string",
  "file": {"@odata.type": "microsoft.graph.file"},
  "fileSystemInfo": {"@odata.type": "microsoft.graph.fileSystemInfo"},
  "folder": {"@odata.type": "microsoft.graph.folder"},
  "id": "string (identifier)",
  "image": {"@odata.type": "microsoft.graph.image"},
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "location": {"@odata.type": "microsoft.graph.geoCoordinates"},
  "name": "string",
  "package": {"@odata.type": "microsoft.graph.package"},
  "parentReference": {"@odata.type": "microsoft.graph.itemReference"},
  "photo": {"@odata.type": "microsoft.graph.photo"},
  "remoteItem": {"@odata.type": "microsoft.graph.remoteItem"},
  "searchResult": {"@odata.type": "microsoft.graph.searchResult"},
  "shared": {"@odata.type": "microsoft.graph.shared"},
  "size": 1024,
  "specialFolder": {"@odata.type": "microsoft.graph.specialFolder"},
  "video": {"@odata.type": "microsoft.graph.video"},
  "webDavUrl": "string",
  "webUrl": "string",

  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
  "children": [ { "@odata.type": "microsoft.graph.driveItem" }],
  "thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
  "permissions": [ {"@odata.type": "microsoft.graph.permission"} ]
}

プロパティ

プロパティ 説明
audio audio オーディオのメタデータ (アイテムがオーディオ ファイルである場合)。読み取り専用です。
content Stream コンテンツのストリーム (アイテムがファイルを表す場合)。
createdBy identitySet そのアイテムを作成したユーザーの ID、デバイス、アプリケーション。読み取り専用です。
createdDateTime DateTimeOffset アイテム作成の日時。読み取り専用です。
cTag String アイテムのコンテンツの eTag。メタデータのみが変更された場合、この eTag は変更されません。注: アイテムがフォルダーである場合、このプロパティは返されません。読み取り専用です。
deleted deleted アイテムの削除状態に関する情報。読み取り専用です。
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 親の情報 (アイテムに親がある場合)。読み取り/書き込み。
写真 photo 写真のメタデータ (アイテムが写真である場合)。読み取り専用です。
remoteItem remoteItem リモート アイテムのデータ (現在アクセス中のドライブ以外のドライブから共有されているアイテムの場合)。読み取り専用です。
searchResult searchResult 検索のメタデータ (検索結果に由来するアイテムの場合)。読み取り専用です。
共有 shared アイテムが他のユーザーと共有されていることを示し、アイテムの共有状態に関する情報を提供します。読み取り専用です。
size Int64 アイテムのサイズ (バイト単位)。読み取り専用です。
specialFolder specialFolder 現在のアイテムが特別なフォルダーとしても使用可能な場合は、このファセットが返されます。読み取り専用です。
video video ビデオのメタデータ (アイテムがビデオである場合)。読み取り専用です。
webUrl String ブラウザーでリソースを表示するための URL。読み取り専用です。

注:eTag プロパティと cTag プロパティは、コンテナー (フォルダー) 上での機能が異なります。cTag 値は、フォルダーのいずれかの子孫のコンテンツまたはメタデータが変更されると変更されます。eTag 値は、子孫から派生したプロパティ (childCountlastModifiedDateTime など) 以外のフォルダーのプロパティが変更されたときにのみ、変更されます。

インスタンスの属性

インスタンスの属性は、動作が特殊なプロパティです。これらのプロパティは一時的なものであり、a) サービスの動作を定義するか、b) 短期的なプロパティの値 (有効期限を持つアイテムのダウンロード URL など) を提供します。

プロパティ名 種類 説明
@microsoft.graph.conflictBehavior string 新しいアイテムを作成するアクションの競合を解決する動作。failreplacerename という値を使用できます。PUT の既定値は replace です。この注釈とともにアイテムが返されることはありません。書き込み専用です。
@microsoft.graph.downloadUrl string このファイルのコンテンツをダウンロードするために使用できる URL。この URL では認証は必要ありません。読み取り専用です。
@microsoft.graph.sourceUrl string PUT 要求を発行するときにこのインスタンスの注釈を使用すると、サービスに対し、URL のコンテンツをダウンロードし、それをファイルとして保存するように指示できます。書き込み専用です。

注:@microsoft.graph.downloadUrl の値は短時間限定の URL であるため、キャッシュすることはできません。URL は短い期間だけ使用でき、その後は無効になります。

リレーションシップ

リレーションシップ 説明
children driveitem コレクション アイテムの直接の子のアイテム オブジェクトを格納するコレクション。子が含まれるのは、フォルダーを表すアイテムのみです。読み取り専用です。Null 許容型。
createdByUser user そのアイテムを作成したユーザーの ID、デバイス、アプリケーション。読み取り専用です。
lastModifiedByUser user アイテムを最終更新したユーザーの ID、デバイス、アプリケーション。読み取り専用です。
アクセス許可 permission コレクション アイテムのアクセス許可のセット。読み取り専用です。Null 許容型。
thumbnails thumbnailSet コレクション アイテムに関連付けられた ThumbnailSet オブジェクトを格納するコレクション。詳細については、サムネイルの取得についてのページをご覧ください。読み取り専用です。Null 許容型。

Methods

Method REST パス
アイテムを取得する GET /drive/items/{item-id}
子を一覧表示する GET /drive/items/{item-id}/children
アイテムを作成する POST /drive/items/{item-id}/children
アイテムを更新する PATCH /drive/items/{item-id}
コンテンツをアップロードする PUT /drive/items/{item-id}/content
コンテンツをダウンロードする GET /drive/items/{item-id}/content
アイテムを削除する DELETE /drive/items/{item-id}
アイテムを移動する PATCH /drive/items/{item-id}
アイテムをコピーする POST /drive/items/{item-id}/copy
アイテムを検索する GET /drive/items/{item-id}/search(q='text')
変更を検索する GET /drive/root/delta
サムネイルを一覧表示する GET /drive/items/{item-id}/thumbnails
共有リンクを作成する POST /drive/items/{item-id}/createLink
アクセス許可を追加する POST /drive/items/{item-id}/invite
アクセス許可を一覧表示する GET /drive/items/{item-id}/permissions
アクセス許可を削除する DELETE /drive/items/{item-id}/permissions/{perm-id}

注釈

OneDrive for Business または SharePoint のドキュメント ライブラリでは、アイテムがフォルダーである場合、cTag プロパティは返されません。