获取 DriveItem 资源

通过文件系统路径或 ID 在驱动器中检索 DriveItem 的元数据。

权限

调用此 API 需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 权限(从最低特权到最高特权)
委派(工作或学校帐户) Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委派(个人 Microsoft 帐户) Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All
应用程序 Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All

HTTP 请求

GET /drives/{drive-id}/items/{item-id}
GET /drives/{drive-id}/root:/{item-path}
GET /groups/{group-id}/drive/items/{item-id}
GET /groups/{group-id}/drive/root:/{item-path}
GET /me/drive/items/{item-id}
GET /me/drive/root:/{item-path}
GET /sites/{siteId}/drive/items/{itemId}
GET /sites/{siteId}/drive/root:/{item-path}
GET /users/{userId}/drive/items/{itemId}
GET /users/{userId}/drive/root:/{item-path}

可选的查询参数

此方法支持 $expand$selectOData 查询参数 来自定义响应。

如果某个项具有子项关系,在检索该项的元数据时可以使用 $expand 查询字符串参数 来包括同一调用中的项的子项。

可选的请求标头

名称 说明
if-none-match String 如果包含此请求标头,且提供的 eTag(或 cTag)与文件中的当前标记不匹配,则返回 HTTP 304 Not Modified 响应。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 DriveItem 资源。

示例

请求

下面是用户的 OneDrive 的根文件夹请求示例。

GET /me/drive/root

响应

下面是一个响应示例。

HTTP/1.1 200 OK
Content-type: application/json

{
  "createdBy": {
      "user": {
          "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
          "displayName": "Ryan Gregg"
      }
  },
  "createdDateTime": "2016-03-21T20:01:37Z",
  "cTag": "\"c:{86EB4C8E-D20D-46B9-AD41-23B8868DDA8A},0\"",
  "eTag": "\"{86EB4C8E-D20D-46B9-AD41-23B8868DDA8A},1\"",
  "folder": { "childCount": 120 },
  "id": "01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK",
  "lastModifiedBy": {
      "user": {
          "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
          "displayName": "Ryan Gregg"
      }
  },
  "lastModifiedDateTime": "2016-03-21T20:01:37Z",
  "name": "OneDrive",
  "root": { },
  "size": 157286400,
  "webUrl": "https://contoso-my.sharepoint.com/personal/rgregg_contoso_com/Documents"
}

HEAD 请求

在大多数情况下,HEAD 请求的行为方式与 GET 请求大致相同。

不同之处有以下两点:

  1. HEAD 请求只返回相应的 GET 请求头。 这是 HEAD 响应的标准做法。
  2. HEAD 请求不会自动预配 特殊文件夹。 相反,如果没有特殊文件夹,则会返回 404 错误。

在此示例中,可以看到,请求获取 OneDrive 根目录的响应直接为 200 OK

HTTP 请求

HEAD /drive/root
Accept: application/json

响应

HTTP/1.1 200 OK

说明

请参阅错误响应,详细了解错误返回方式。