SharePoint Embedded
Microsoft SharePoint Embedded 是一个基于云的文件和文档管理系统,适合在任何应用程序中使用。 SharePoint Embedded 是一种仅限 API 的解决方案,它使应用开发人员能够利用适用于任何应用的 Microsoft 365 文件和文档存储平台的强大功能,适用于构建业务线应用程序和构建多租户应用程序的企业。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 标准 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 标准 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | Microsoft |
| URL | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| spe-connector@service.microsoft.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| 隐私策略 | https://privacy.microsoft.com/ |
| 类别 | 内容和文件 |
入门
在使用 SharePoint Embedded 连接器之前,需要创建 SharePoint Embedded 应用程序。 请参阅 SharePoint Embedded 文档 ,了解详细信息并开始使用。
授予对 SharePoint Embedded 连接器的访问权限
为了使 SharePoint Embedded 连接器与租户中的文件存储容器和内容进行交互,你需要在该租户上containerTypeRegistration为 SharePoint Embedded 连接器应用程序创建一个applicationPermissionGrant。 这样,SharePoint Embedded 连接器就可以访问租户上应用的特定容器类型。
full使用 Microsoft 图形 API 授予delegated对 SharePoint Embedded 连接器应用程序 ID e8e1b0bf-140f-4b8b-8e94-fbe8937fad04 的权限。
PUT /storage/fileStorage/containerTypeRegistrations/{containerTypeId}/applicationPermissionGrants/e8e1b0bf-140f-4b8b-8e94-fbe8937fad04
Content-Type: application/json
{
"delegatedPermissions": ["full"],
"applicationPermissions": ["none"]
}
有关详细信息,请参阅 Create fileStorageContainerTypeAppPermissionGrant API 参考文章。
已知问题和限制
- 创建文件任务支持的最大文件大小为 10MB
- 创建容器不适用于连接器
- 仅支持委派身份验证
操作
| 列出容器 |
列出容器 |
| 列出容器中的项 |
此作获取容器中的文件和子文件夹的列表。 |
| 列出容器列 |
列出定义容器架构的列 |
| 列出容器权限 |
列出容器的权限 |
| 列出已回收的容器 |
列出已回收的容器 |
| 列出已回收的项目 |
此作列出了 SharePoint Embedded 容器回收站中的项。 |
| 列出文件字段 |
此作获取与 SharePoint Embedded 容器中的文件关联的列表项字段(元数据)。 |
| 列出文件版本 |
此作列出了 SharePoint Embedded 容器中文件的早期版本。 |
| 列出缩略图 |
此作列出了 SharePoint Embedded 容器中文件的可用缩略图。 |
| 列表项共享权限 |
此作列出了 SharePoint Embedded 容器中项的共享权限。 |
| 创建共享链接 |
此作为 SharePoint Embedded 容器中的文件创建共享链接。 |
| 创建容器列 |
创建定义容器架构的列 |
| 创建容器权限 |
创建对容器的权限 |
| 创建文件 |
此作将创建一个文件并返回 driveItem 的元数据。 |
| 创建文件夹 |
此作在 SharePoint Embedded 容器中(根级别或另一个文件夹)中创建新文件夹。 |
| 创建文件预览 |
此作为 SharePoint Embedded 容器中的文件创建预览。 |
| 删除共享权限 |
此作删除 SharePoint Embedded 容器中文件的特定共享权限。 |
| 删除容器 |
删除容器 |
| 删除容器列 |
删除定义容器架构的列 |
| 删除容器权限 |
删除对容器的权限 |
| 删除已回收的容器 |
永久删除已回收的容器 |
| 删除已回收的项目 |
此作将从 SharePoint Embedded 容器的回收站中永久删除一个或多个已回收的项目。 |
| 删除文件 |
此作将删除 SharePoint Embedded 容器中的文件。 |
| 删除文件版本 |
此作将删除 SharePoint Embedded 容器中文件的特定版本。 |
| 发送共享邀请 |
此作为 SharePoint Embedded 容器中的文件发送共享邀请。 |
| 放弃签出 |
此作会放弃签出 SharePoint Embedded 容器中的文件。 |
| 更新容器 |
更新容器 |
| 更新容器权限 |
更新对容器的权限 |
| 更新容器自定义属性 |
更新容器的自定义属性 |
| 更新文件内容 |
此作将更新文件的内容。 |
| 激活容器 |
激活容器 |
| 签入文件 |
此作签入 SharePoint Embedded 容器中已签出的文件。 |
| 签出文件 |
此作签出 SharePoint Embedded 容器中的文件,从而阻止其他人编辑文档。 |
| 获取共享权限 |
此作获取 SharePoint Embedded 容器中文件的特定共享权限。 |
| 获取容器 |
获取容器 |
| 获取容器列 |
获取容器的列 |
| 获取容器自定义属性 |
获取容器的自定义属性 |
| 获取文件内容 |
此作获取文件的内容。 |
| 获取文件属性 |
此作获取 SharePoint Embedded 容器中文件的属性。 |
| 获取文件版本 |
此作获取 SharePoint Embedded 容器中文件的特定版本。 |
| 获取缩略图 |
此作获取 SharePoint Embedded 容器中文件的特定缩略图。 |
| 设置文件字段 |
此作将更新与 SharePoint Embedded 容器中的文件关联的列表项字段(元数据)。 使用 null 值清除字段值。 |
| 还原已回收的容器 |
还原已回收的容器 |
| 还原已回收的项目 |
此作从 SharePoint Embedded 容器的回收站还原一个或多个回收项。 |
| 重命名文件 |
此作重命名 SharePoint Embedded 容器中的文件。 |
列出容器
列出容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器类型 ID
|
containerType | True | string |
列出指定容器类型的容器 |
返回
列出容器中的项
此作获取容器中的文件和子文件夹的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
父文件夹 ID
|
parentId | True | string |
要从中列出项的父文件夹的 ID。 使用“root”从容器的根级别获取项目,或提供特定的文件夹 ID 从该文件夹中获取项目 |
|
过滤器
|
$filter | string |
结果的筛选条件(OData 格式),例如:parentReference/id eq '{{folderId}}' AND contains(listitem/fields/FileLeafRef, {{user_name_string}}) |
|
|
选择
|
$select | string |
要包含在结果中的属性(逗号分隔) |
|
|
展开
|
$expand | string |
响应中要扩展的相关资源 |
|
|
Top
|
$top | integer |
要返回的结果数 |
|
|
订单依据
|
$orderby | string |
按以下方式对结果进行排序的字段(s)和方向 |
返回
表示驱动器项的页面。
列出容器列
列出定义容器架构的列
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
过滤器
|
$filter | string |
要应用于结果的筛选器 |
返回
列出容器权限
列出容器的权限
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
返回
列出已回收的容器
列出已回收的容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器类型 ID
|
containerType | True | string |
列出指定容器类型的已回收容器 |
返回
列出已回收的项目
此作列出了 SharePoint Embedded 容器回收站中的项。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
返回
回收站中的项目集合
列出文件字段
此作获取与 SharePoint Embedded 容器中的文件关联的列表项字段(元数据)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
字段的 ETag 值 |
列出文件版本
此作列出了 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 |
文件的唯一标识符 |
返回
表示缩略图集的集合
- Body
- ThumbnailSets
列表项共享权限
此作列出了 SharePoint Embedded 容器中项的共享权限。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
项 ID
|
file-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
创建容器列
创建定义容器架构的列
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
|
object |
返回
创建容器权限
创建对容器的权限
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
权限角色
|
roles | True | array of string |
要授予用户的角色 |
|
用户主体名称
|
userPrincipalName | True | string |
标识用户主体名称 |
返回
创建文件
此作将创建一个文件并返回 driveItem 的元数据。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
父 ID
|
parent-id | True | string |
父文件夹的驱动器项 ID 或“root” |
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件名
|
file-name | True | string |
文件的名称 |
|
文件内容(Base64)
|
body | True | byte |
Base64 编码的文件内容 |
返回
驱动器项元数据
- 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 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 |
文件的唯一标识符 |
|
权限 ID
|
permission-id | True | string |
要删除的权限的唯一标识符 |
删除容器
删除容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
删除容器列
删除定义容器架构的列
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
列 ID
|
column-id | True | string |
列 ID |
删除容器权限
删除对容器的权限
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
权限 ID
|
permission-id | True | string |
权限 ID |
删除已回收的容器
永久删除已回收的容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
删除已回收的项目
此作将从 SharePoint Embedded 容器的回收站中永久删除一个或多个已回收的项目。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
项 ID
|
ids | True | array of string |
要永久删除的已回收项 ID 的数组 |
删除文件
此作将删除 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 |
文件的唯一标识符 |
|
需要登录
|
requireSignIn | True | boolean |
指示是否要求邀请的收件人登录才能查看共享项目 |
|
角色
|
roles | True | array of string |
授予共享邀请收件人的权限 |
|
Email
|
string |
收件人的电子邮件地址 |
||
|
别名
|
alias | string |
收件人的别名(如果Microsoft 365 收件人) |
|
|
对象标识符
|
objectId | string |
Azure Active Directory 中收件人的唯一标识符 |
|
|
Message
|
message | True | string |
作为共享邀请的一部分发送的自定义消息 |
|
发送邀请
|
sendInvitation | True | boolean |
如果为 true,则向收件人发送共享链接。 如果为 false,则会创建权限,但不会发送邀请消息。 |
返回
表示文件或文件夹的权限列表
放弃签出
此作会放弃签出 SharePoint Embedded 容器中的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
更新容器
更新容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 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 |
|
权限 ID
|
permission-id | True | string |
权限 ID |
|
权限角色
|
roles | True | array of string |
要授予用户的角色 |
返回
更新容器自定义属性
更新容器的自定义属性
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
|
object |
返回
更新文件内容
此作将更新文件的内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件内容(Base64)
|
body | True | byte |
Base64 编码的文件内容 |
返回
文件的内容
- 文件内容
- binary
激活容器
激活容器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
签入文件
此作签入 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 |
文件的唯一标识符 |
获取共享权限
此作获取 SharePoint Embedded 容器中文件的特定共享权限。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
|
权限 ID
|
permission-id | True | string |
权限的唯一标识符 |
返回
表示文件或文件夹的权限
获取容器
获取容器列
获取容器的列
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
|
列 ID
|
column-id | True | string |
列 ID |
返回
获取容器自定义属性
获取容器的自定义属性
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器 ID |
返回
获取文件内容
此作获取文件的内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
获取文件属性
此作获取 SharePoint Embedded 容器中文件的属性。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
返回
驱动器项元数据
- Body
- DriveItem
获取文件版本
此作获取 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 |
文件的唯一标识符 |
|
缩略图 ID
|
thumbnail-id | True | string |
缩略图集的唯一标识符 |
|
尺寸
|
size | True | string |
要检索的缩略图的大小 |
返回
表示单个缩略图
- Body
- Thumbnail
设置文件字段
此作将更新与 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
|
ids | True | array of string |
要还原的已回收项 ID 数组 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
项 ID
|
value.id | string |
还原项的 ID |
重命名文件
此作重命名 SharePoint Embedded 容器中的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
容器 ID
|
container-id | True | string |
容器的唯一标识符 |
|
文件 ID
|
file-id | True | string |
文件的唯一标识符 |
|
Name
|
name | string |
文件的新名称 |
返回
驱动器项元数据
- Body
- DriveItem
触发器
| 监视容器中的项更改 |
在 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 |
标识显示名称 |
|
Email
|
grantedToV2.user.email | string |
标识电子邮件 |
|
用户主体名称
|
grantedToV2.user.userPrincipalName | string |
标识用户主体名称 |
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.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
|
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 |
父文件夹的路径 |
|
站点标识符
|
parentReference.siteId | string |
包含项的网站 ID |
|
应用程序 ID
|
createdBy.application.id | string |
创建项的应用程序的 ID |
|
应用程序名称
|
createdBy.application.displayName | string |
创建项的应用程序的显示名称 |
|
用户 ID
|
createdBy.user.id | string |
创建项的用户的 ID |
|
用户名
|
createdBy.user.displayName | string |
创建项的用户的显示名称 |
|
应用程序 ID
|
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 |
|
displayName
|
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 |
权限过期的日期和时间 |
|
授予标识
|
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 |
表示单个缩略图 |
|
中
|
medium | Thumbnail |
表示单个缩略图 |
|
小
|
small | Thumbnail |
表示单个缩略图 |
|
源
|
source | Thumbnail |
表示单个缩略图 |
缩略图
表示单个缩略图
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
高度
|
height | integer |
缩略图的高度(以像素为单位) |
|
宽度
|
width | integer |
缩略图的宽度(以像素为单位) |
|
URL
|
url | string |
缩略图的 URL |
ThumbnailSets
表示缩略图集的集合
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of ThumbnailSet |
缩略图集的集合 |
RecycleBinItem
表示回收站中的项目
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | string |
已回收项的唯一标识符 |
|
Name
|
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”。