Listar seções

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha a lista de seções do trabalho em equipe de um usuário.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Seção de Trabalho em Equipe.Leia TeamworkSection.ReadWrite
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application TeamworkSection.Read.All TeamworkSection.ReadWrite.All

Solicitação HTTP

GET /users/{user-id}/teamwork/sections

Parâmetros de consulta opcionais

Esse método dá suporte $expand ao parâmetro de consulta OData para ajudar a personalizar a resposta. Somente a relação de itens pode ser expandida e apenas um nível de expansão tem suporte. Para obter mais informações, consulte Parâmetros de consulta OData.

Quando $expand=items for especificado, a resposta incluirá a coleção items embutida em cada seção:

  • Para seções definidas pelo usuário, a coleção de itens contém os chats, canais, reuniões e comunidades organizados dentro da seção.
  • Para seções definidas pelo sistema, a coleção de itens é sempre retornada como uma matriz vazia ([]). O conteúdo da seção definido pelo sistema não é exposto por meio da API do Graph pública. Para enumerar itens em uma seção definida pelo usuário sem usar $expand, use Itens de lista.

Quando $expand=items for especificado, a resposta não incluirá as anotações de instância @microsoft.graph.sectionsOrder e @microsoft.graph.sectionsVersion . Para obter os itens e essas anotações, emita uma solicitação separada sem $expand.

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos teamworkSection no corpo da resposta.

A resposta inclui as seguintes anotações de instância OData na coleção.

Annotation Tipo Descrição
@microsoft.graph.sectionsOrder String collection Uma matriz ordenada de IDs de seção que representam a ordem de seção preferida do usuário.
@microsoft.graph.sectionsVersion Cadeia de caracteres A versão atual da hierarquia de seções. Use esse valor como o cabeçalho para o If-Match controle de simultaneidade otimista em operações de mutação (criar, atualizar, excluir ou reordenar seções e adicionar, remover, mover ou reordenar itens).

Exemplos

Exemplo 1: listar seções

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "@microsoft.graph.sectionsOrder": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "@microsoft.graph.sectionsVersion": "1742515200",
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Favorites",
      "displayIcon": {
        "iconType": "⭐",
        "displayName": "Star",
        "contentUrl": null,
        "skinTone": null
      },
      "sectionType": "userDefined",
      "sortType": "mostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": false,
      "createdDateTime": "2025-01-15T10:30:00Z",
      "lastModifiedDateTime": "2025-03-01T14:22:00Z"
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "displayName": "Teams and Channels",
      "displayIcon": null,
      "sectionType": "systemDefined",
      "sortType": "unreadThenMostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": true,
      "createdDateTime": "2024-06-10T08:00:00Z",
      "lastModifiedDateTime": "2025-02-28T16:45:00Z"
    }
  ]
}

Exemplo 2: Listar seções com itens expandidos

O exemplo a seguir usa $expand=items para retornar cada seção junto com sua coleção de itens em uma única solicitação. A seção definida pelo usuário retorna seus itens embutidos, enquanto a seção definida pelo sistema retorna uma matriz de itens vazia porque o conteúdo da seção definida pelo sistema não é exposto por meio da API do Graph pública.

Solicitação

GET https://graph.microsoft.com/beta/users/10f8c3a6-3e2a-4e8b-9c7d-5a4b6c8d9e0f/teamwork/sections?$expand=items

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Favorites",
      "sectionType": "userDefined",
      "sortType": "mostRecent",
      "isExpanded": true,
      "isHierarchicalViewEnabled": false,
      "createdDateTime": "2025-01-15T10:30:00Z",
      "lastModifiedDateTime": "2025-03-01T14:22:00Z",
      "items": [
        {
          "@odata.type": "#microsoft.graph.teamworkSectionItem",
          "id": "19:d5b2c3a4-e6f7-8901-abcd-ef3456789012@thread.v2",
          "itemType": "chat",
          "createdDateTime": "2025-02-10T09:15:00Z",
          "lastModifiedDateTime": "2025-03-05T11:30:00Z"
        },
        {
          "@odata.type": "#microsoft.graph.teamworkSectionItem",
          "id": "19:e6f7a8b9-0123-4567-89ab-cdef01234567@thread.tacv2",
          "itemType": "channel",
          "createdDateTime": "2025-01-20T14:00:00Z",
          "lastModifiedDateTime": "2025-03-01T08:45:00Z"
        }
      ]
    },
    {
      "@odata.type": "#microsoft.graph.teamworkSection",
      "@odata.etag": "\"1742515200\"",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "displayName": "Teams and Channels",
      "sectionType": "systemDefined",
      "sortType": "nameAlphabetical",
      "isExpanded": true,
      "isHierarchicalViewEnabled": true,
      "createdDateTime": "2024-06-10T08:00:00Z",
      "lastModifiedDateTime": "2025-02-28T16:45:00Z",
      "items": []
    }
  ]
}