Compartilhar via

sitePage: getWebPartsByPosition

  • Artigo

Namespace: microsoft.graph

Obtenha uma coleção de peças Web ao fornecer informações de webPartPosition .

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) Sites.Read.All Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sites.Read.All Sites.ReadWrite.All

Solicitação HTTP

GET /sites/{site-id}/pages/{page-id}/microsoft.graph.sitepage/getWebPartsByPosition

Parâmetros de função

No URL do pedido, forneça um ou mais parâmetros seguintes com um valor válido.

Parâmetro Tipo Descrição
columnId Duplo Indica o identificador da coluna onde a Peça Web se localizou. Só funciona se horizontalSectionId for fornecido.
horizontalSectionId Duplo Indica a secção horizontal onde a Peça Web se localizou.
isInVerticalSection booliano Indique se a Peça Web está contida na secção vertical atual.
webPartIndex Duplo O índice da Peça Web atual. Representa a ordem da Peça Web na coluna ou secção atual. Só funciona se for columnId fornecido ou isInVerticalSection fornecido.

Parâmetros de consulta opcionais

Este método suporta os $expandparâmetros de consulta , $filtere $selectOData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

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 webPart no corpo da resposta.

Exemplos

Solicitação

Veja a seguir um exemplo de uma solicitação.

GET https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/getWebPartsByPosition?isInVerticalSection=true

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.textWebPart",
      "id": "d79d70af-27ea-4208-8dce-23c3bf678664",
      "innerHtml": "<h2>How do you get started?</h2>"
    }
  ]
}