命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新用户团队合作中分区的属性。 对于系统定义的节,只能更新 sortType 属性。
API 可用性
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | TeamworkSection.ReadWrite | 不可用。 |
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
| 应用程序 | TeamworkSection.ReadWrite.All | Teamwork.Migrate.All |
HTTP 请求
PATCH /users/{user-id}/teamwork/sections/{teamworkSection-id}
请求标头
| 标头 | 值 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json. 必需。 |
请求正文
在请求正文中,仅提供要更新的属性的 JSON 表示形式。 可更新以下属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| displayIcon | sectionDisplayIcon | 为分区显示的图标。 |
| displayName | String | 分区的显示名称。 最大长度为 50 个字符。 显示名称区分大小写,并且在用户的部分中必须是唯一的。 无法使用保留的系统定义名称 (RecentChats、 QuickViews、 TeamsAndChannels、 MutedChatsMeetingChats) EngageCommunities 。 |
| isExpanded | 布尔值 | 指示该部分是否在用户界面中展开。 |
| sortType | sectionSortType | 节中项目的排序顺序。 可能的值包括 mostRecent、unreadThenMostRecent、nameAlphabetical、userDefinedCustomOrder、unknownFutureValue。 |
重要
有效的 sortType 值取决于节类型:
-
用户定义的节:
mostRecent、和unreadThenMostRecentuserDefinedCustomOrder有效。 不支持nameAlphabetical。 -
系统定义的节:有效值取决于特定节。 例如,Teams 和频道部分支持 ,但 RecentChats 和 MutedChats 部分不支持
nameAlphabetical。 当属性 isHierarchicalViewEnabledtrue设置为 时,仅nameAlphabetical有效。
响应
如果成功,此方法将在响应正文中返回 200 OK 响应代码和更新的 teamworkSection 对象。
可能出现以下错误。
| 响应代码 | 邮件 |
|---|---|
400 Bad Request |
必须至少提供一个属性才能进行更新。 |
400 Bad Request |
“displayName”属性不能为空或空格,或者不能超过 50 个字符。 |
400 Bad Request |
属性“{propertyName}”为只读或不可更新。 只能更新 displayName、 displayIcon、 isExpanded 和 sortType 。 |
400 Bad Request |
指定的排序类型对此部分无效。 有关详细信息,请参阅 请求正文 部分。 |
403 Forbidden |
此部分是系统生成的,无法修改。 只能在系统定义的节上更新 sortType 属性。 |
404 Not Found |
未找到指定的部分。 |
409 Conflict |
已存在具有此显示名称的分区。 当请求的 displayName 与现有用户定义的节或保留的系统定义的节名称匹配时返回。 比较区分大小写。 |
409 Conflict |
由于并发更改,无法更新该部分。 请重试请求。 |
示例
示例 1:更新分区的显示名称
以下示例显示如何更新 teamworkSection 对象的显示名称。
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/a1b2c3d4-e5f6-7890-abcd-ef1234567890
Content-type: application/json
{
"displayName": "Important Conversations"
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "#microsoft.graph.teamworkSection",
"@odata.etag": "\"1742515210\"",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Important Conversations",
"displayIcon": {
"iconType": "⭐",
"displayName": "Star",
"contentUrl": null,
"skinTone": null
},
"sectionType": "userDefined",
"sortType": "mostRecent",
"isExpanded": true,
"isHierarchicalViewEnabled": false,
"createdDateTime": "2025-01-15T10:30:00Z",
"lastModifiedDateTime": "2026-03-08T09:15:00Z"
}
示例 2:更新节的排序顺序
以下示例演示了如何更新 teamworkSection 对象的排序顺序。
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/a1b2c3d4-e5f6-7890-abcd-ef1234567890
Content-type: application/json
{
"sortType": "unreadThenMostRecent"
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "#microsoft.graph.teamworkSection",
"@odata.etag": "\"1742515220\"",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Important Conversations",
"displayIcon": {
"iconType": "⭐",
"displayName": "Star",
"contentUrl": null,
"skinTone": null
},
"sectionType": "userDefined",
"sortType": "unreadThenMostRecent",
"isExpanded": true,
"isHierarchicalViewEnabled": false,
"createdDateTime": "2025-01-15T10:30:00Z",
"lastModifiedDateTime": "2026-03-08T09:20:00Z"
}