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 secções no trabalho de equipa de um utilizador.

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) TeamworkSection.Read 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

Este método suporta o $expand parâmetro de consulta OData para ajudar a personalizar a resposta. Apenas a relação de itens pode ser expandida e só é suportado um nível de expansão. Para obter mais informações, consulte Parâmetros de consulta OData.

Quando $expand=items for especificado, a resposta inclui a coleção de itens inline em cada secção:

  • Para secções definidas pelo utilizador, a coleção de itens contém as conversas, canais, reuniões e comunidades organizadas na secção.
  • Para secções definidas pelo sistema, a coleção de itens é sempre devolvida como uma matriz vazia ([]). Os conteúdos das secções definidas pelo sistema não são expostos através da API do Graph pública. Para enumerar itens numa secção definida pelo utilizador sem utilizar $expando , utilize Itens de lista.

Quando $expand=items for especificado, a resposta não inclui as anotações de instâncias @microsoft.graph.sectionsOrder e @microsoft.graph.sectionsVersion . Para obter os itens e estas anotações, emita um pedido separado 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, este método devolve 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 secção que representam a ordem de secção preferencial do utilizador.
@microsoft.graph.sectionsVersion Cadeia de caracteres A versão atual da hierarquia de secções. Utilize este valor como cabeçalho para o If-Match controlo de simultaneidade otimista nas operações de mutação (criar, atualizar ou eliminar secções e adicionar, remover ou mover itens).

Exemplos

Exemplo 1: listar secçõ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 secções com itens expandidos

O exemplo seguinte utiliza $expand=items para devolver cada secção juntamente com a respetiva coleção de itens num único pedido. A secção definida pelo utilizador devolve os respetivos itens inline, enquanto a secção definida pelo sistema devolve uma matriz de itens vazios porque os conteúdos das secções definidas pelo sistema não são expostos através 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": []
    }
  ]
}