Obtener SitePage
Espacio de nombres: microsoft.graph
Devuelve los metadatos de un sitePage en la lista de páginas de sitio de un sitio.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
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
Parámetros de consulta opcionales
Este método admite los $select
parámetros de consulta y $expand
OData para ayudar a personalizar la respuesta. Para obtener información general, vea Parámetros de consulta OData.
Puede usar el parámetro de $expand=canvasLayout
cadena de consulta para incluir el contenido de un elemento al recuperar los metadatos de un elemento si el elemento tiene una relación =canvasLayout .
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. Necesario. |
Aceptar | application/json; odata.metadata=none. Opcional. Quita todos los metadatos de OData de la respuesta. Se recomienda incluir este encabezado cuando se usará la respuesta en otra solicitud. |
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
objeto y un objeto sitePage en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Obtener una página en la lista de páginas de sitio de un sitio
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "microsoft.graph.sitePage",
"description": "Here's the page description",
"id": "65e59907-59d5-44ff-a038-7c0bf3098c01",
"name": "Home.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/Home.aspx",
"title": "Organization Home",
"thumbnailWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/00210d24-bba0-42e6-9a31-1d452a95dd75/thumbnails/large.jpg?file=163352059.jpg",
"promotionKind": "page",
"pageLayout": "home",
"showComments": true,
"showRecommendedPages": false,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"publishingState": {
"level": "published",
"versionId": "1.0"
},
"reactions": {
"commentCount": 1
}
}
Ejemplo 2: Obtener una página mediante seleccionar y expandir
Solicitud
Con $select
las instrucciones y $expand
, puede recuperar los metadatos de sitePage y el contenido de página en una sola solicitud.
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$select=id,name
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"name": "Electronic Convertible.aspx"
}
Ejemplo 3: Obtención de una página con contenido de página
Solicitud
Puede expandir las referencias en la dirección URL con el parámetro de consulta $expand . Para acceder a la página con contenido de página, anexe la cadena de ?$expand=canvasLayout
consulta.
GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage?$expand=canvasLayout
Respuesta
En el ejemplo siguiente se muestra la respuesta.
{
"description": "Reiciendis placeat dolores.",
"eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",
"lastModifiedDateTime": "2023-04-16T10:01:41Z",
"name": "autotest Electronic Convertible.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/autotest Electronic Convertible.aspx",
"title": "autotest Electronic Convertible",
"pageLayout": "article",
"thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/sitepagethumbnail.png",
"promotionKind": "page",
"showComments": false,
"showRecommendedPages": true,
"createdBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Rahul Mittal",
"email": "rahmit@contoso.com"
}
},
"parentReference": {
"listId": "468fc883-e278-4773-ba09-91351a1e42ed",
"siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"
},
"contentType": {
"id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",
"name": "Site Page"
},
"publishingState": {
"level": "draft",
"versionId": "0.4"
},
"reactions": {},
"canvasLayout": {
"horizontalSections": [
{
"layout": "threeColumns",
"id": "1",
"emphasis": "neutral",
"columns": [
{
"id": "1",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "f6d0ef70-c977-45e4-ae4b-4676a30d5aab",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "2",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "99f59f91-c853-433e-9e75-ad7a32e46106",
"innerHtml": "<h1>sample content</h1>"
}
]
},
{
"id": "3",
"width": 4,
"webparts": [
{
"@odata.type": "#oneDrive.textWebPart",
"id": "48998492-9633-48b8-a7e9-d293533b4fa6",
"innerHtml": "<h1>sample content</h1>"
}
]
}
]
}
]
}
}