sitePage: getWebPartsByPosition

  • Artículo

Espacio de nombres: microsoft.graph

Obtenga una colección de webPart proporcionando información de webPartPosition .

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Sites.Read.All Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Sites.Read.All Sites.ReadWrite.All

Solicitud HTTP

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

Parámetros de función

En la dirección URL de la solicitud, proporcione uno o varios parámetros siguientes con un valor válido.

Parámetro Tipo Descripción
columnId Doble Indica el identificador de la columna donde se encuentra el elemento WebPart. Solo funciona si horizontalSectionId se proporciona.
horizontalSectionId Doble Indica la sección horizontal donde se encuentra el elemento WebPart.
isInVerticalSection booleano Indique si el elemento WebPart está incluido en la sección vertical actual.
webPartIndex Doble Índice del elemento WebPart actual. Representa el orden de WebPart en la columna o sección actual. Solo funciona si columnId se proporciona o isInVerticalSection .

Parámetros de consulta opcionales

Este método admite los $expandparámetros de consulta , $filtery $select OData para ayudar a personalizar la respuesta.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y una colección de objetos webPart en el cuerpo de la respuesta.

Ejemplos

Solicitud

A continuación se muestra un ejemplo de una solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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>"
    }
  ]
}