teamworkSection: 並べ替え

名前空間: microsoft.graph

重要

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

ユーザーのチームワークのセクションを並べ替えます。 sectionsOrder コレクションには、リスト セクションによって返されるすべてのセクション ID を 1 回だけ含める必要があります。 コレクションに QuickViews システム セクションが含まれている場合は、そのセクションが最初になければなりません。

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

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

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) TeamworkSection.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション TeamworkSection.ReadWrite.All Teamwork.Migrate.All

HTTP 要求

POST /me/teamwork/sections/reorder
POST /users/{user-id}/teamwork/sections/reorder

要求ヘッダー

ヘッダー
Authorization 必須。 認証と認可についての詳細をご覧ください。
Content-Type application/json. Required.
If-Match セクションを一覧表示するときに返される @microsoft.graph.sectionsVersion 注釈の値、または以前に取得したセクション@odata.etag 値。 オプティミスティック同時実行制御に必要です。

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表に、このアクションを呼び出すときに必要なパラメータを示します。

パラメーター 説明
sectionsOrder String collection セクション ID の完全な順序付きリスト。 リスト セクションによって返されるすべてのセクション ID を 1 回だけ含めます。 QuickViews システム セクションが含まれている場合は、最初の ID である必要があります。 必須です。

応答

成功した場合、このアクションは要求された順序で、 200 OK 応答コードと teamworkSection コレクションを応答本文で返します。

注:

返される各セクションには、更新された @odata.etag 値が含まれます。 この値は、後続の変更操作の If-Match ヘッダーとして使用します。

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

応答コード メッセージ
400 Bad Request sectionsOrder プロパティが見つからないか、空であるか、サポートされている最大値を超えているか、ID が null、空、または重複しています。
400 Bad Request 並べ替え一覧には、現在のすべてのセクションが 1 回だけ含まれていない、不明なセクション ID が含まれている、または QuickViews システム セクションが最初に配置されていない。
404 Not Found 指定されたユーザーが見つかりませんでした。
409 Conflict 再注文リスト内のセクションが、再注文要求と同時に削除されました。 セクションを再度一覧表示 し、現在のセクション ID とバージョンで再試行します。
412 Precondition Failed If-Match ヘッダー値が現在のセクション階層バージョンと一致しません。 セクションを再度一覧表示して、最新の @microsoft.graph.sectionsVersion 注釈を取得して再試行します。
428 Precondition Required この操作には If-Match ヘッダーが必要です。

要求

次の例では、ユーザーの 3 つのセクションを並べ替えます。

POST https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections/reorder
Content-Type: application/json
If-Match: "1742515200"

{
  "sectionsOrder": [
    "ce274158-f4f5-4ba7-bd18-0b2204dc1691~10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f~QuickViews",
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ]
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515210\"",
      "id": "ce274158-f4f5-4ba7-bd18-0b2204dc1691~10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f~QuickViews",
      "displayName": "QuickViews",
      "sectionType": "systemDefined",
      "sortType": "nameAlphabetical"
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515210\"",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Project Alpha",
      "sectionType": "userDefined",
      "sortType": "userDefinedCustomOrder"
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515210\"",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "displayName": "Customer Escalations",
      "sectionType": "userDefined",
      "sortType": "mostRecent"
    }
  ]
}