teamworkSection を更新

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ユーザーのチームワークのセクションのプロパティを更新する。システム定義セクションでは、 sortType プロパティのみを更新できます。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この 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	文字列	セクションの表示名。最大長は 50 文字です。表示名は大文字と小文字が区別され、ユーザーのセクション内で一意である必要があります。予約済みのシステム定義名 (`RecentChats`、 `QuickViews`、 `TeamsAndChannels`、 `MutedChats`、 `MeetingChats`、 `EngageCommunities`) は使用できません。
isExpanded	ブール型	セクションがユーザーインターフェイスで展開されているかどうかを示します。
sortType	sectionSortType	セクション内のアイテムの並べ替え順序。使用可能な値: `mostRecent`、`unreadThenMostRecent`、`nameAlphabetical`、`userDefinedCustomOrder`、`unknownFutureValue`。

重要

有効な sortType 値は、セクションの種類によって異なります。

ユーザー定義セクション: mostRecent、 unreadThenMostRecent、および userDefinedCustomOrder は有効です。 nameAlphabetical はサポートされていません。
システム定義セクション: 有効な値はセクションごとに異なります。たとえば、 Teamsセクションとチャネル セクションでは nameAlphabetical がサポートされますが、 RecentChats セクションと MutedChats セクションではサポートされていません。プロパティ isHierarchicalViewEnabled が true に設定されている場合、 nameAlphabetical のみが有効です。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された teamworkSection オブジェクトを返します。

次のエラーが発生する可能性があります。

応答コード	メッセージ
`400 Bad Request`	更新するには、少なくとも 1 つのプロパティを指定する必要があります。
`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 オブジェクトの並べ替え順序を更新する方法を示しています。

要求