sitePage resource type

Article
07/23/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

This resource represents a page in the sitePages list. It contains the title, layout, and a collection of webParts.

Inherits from baseSitePage.

Methods

Method	Return type	Description
List	sitePage collection	Get a list of the sitePage objects and their properties.
Create	sitePage	Create a new sitePage object.
Get	sitePage	Read the properties and relationships of a sitePage object.
Update	sitePage	Update the properties of a sitePage object.
Delete	None	Deletes a sitePage object.
Publish	None	Publish a sitePage object.
Get by position	webPart collection	Get a collection of WebPart by providing webPartPosition information.
Save as template	pageTemplate	Save a sitePage as a pageTemplate in a site.
Create from template	sitePage	Create a new sitePage from a pageTemplate in a site.

Properties

Property	Type	Description
contentType	contentTypeInfo	The content type of this item. Inherited from baseSitePage.
createdBy	identitySet	Identity of the creator of this item. Read-only. Inherited from baseSitePage.
createdDateTime	DateTimeOffset	The date and time the item was created. Read-only. Inherited from baseSitePage.
description	String	The descriptive text for the item. Inherited from baseSitePage.
eTag	String	ETag for the item. Inherited from baseSitePage.
id	String	The unique identifier of the item. Inherited from baseSitePage.
lastModifiedBy	identitySet	TIdentity of the last modifier of this item. Read-only. Inherited from baseSitePage.
lastModifiedDateTime	DateTimeOffset	The date and time the item was last modified. Read-only. Inherited from baseSitePage.
name	String	The name of the item. Inherited from baseSitePage.
pageLayout	pageLayoutType	The name of the page layout of the page. The possible values are: `microsoftReserved`, `article`, `home`, `unknownFutureValue`. Inherited from baseSitePage.
parentReference	itemReference	Parent information, if the item has a parent. Inherited from baseSitePage.
promotionKind	pagePromotionType	Indicates the promotion kind of the sitePage. The possible values are: `microsoftReserved`, `page`, `newsPost`, `unknownFutureValue`.
publishingState	publicationFacet	The publishing status and the MM.mm version of the page. Inherited from baseSitePage.
reactions	reactionsFacet	Reactions information for the page.
showComments	Boolean	Determines whether or not to show comments at the bottom of the page.
showRecommendedPages	Boolean	Determines whether or not to show recommended pages at the bottom of the page.
thumbnailWebUrl	String	Url of the sitePage's thumbnail image
title	String	Title of the sitePage. Inherited from baseSitePage.
titleArea	titleArea	Title area on the SharePoint page.
webUrl	String	URL that displays the resource in the browser. Read-only. Inherited from baseSitePage.

pagePromotionType values

Value	Description
`microsoftReserved`	The page is a special type, reserved for use by Microsoft only. This value cannot be used when creating the page with Create sitePage method.
`page`	The page is promoted as a normal page
`newsPost`	The page is promoted as a news post
`unknownFutureValue`	Marker value for future compatibility.

Relationships

Relationship	Type	Description
canvasLayout	canvasLayout	Indicates the layout of the content in a given SharePoint page, including horizontal sections and vertical sections.
createdByUser	user	Identity of the creator of this item. Read-only. Inherited from baseSitePage.
lastModifiedByUser	user	Identity of the last modifier of this item. Read-only. Inherited from baseSitePage.
webParts	webPart collection	Collection of webparts on the SharePoint page.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.sitePage",
  "id": "String (identifier)",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "contentType": {
    "@odata.type": "microsoft.graph.contentTypeInfo"
  },
  "description": "String",
  "eTag": "String",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "name": "String",
  "parentReference": {
    "@odata.type": "microsoft.graph.itemReference"
  },
  "webUrl": "String",
  "title": "String",
  "pageLayout": "String",
  "promotionKind": "String",
  "publishingState": {
    "@odata.type": "microsoft.graph.publicationFacet"
  },
  "reactions": {
    "@odata.type": "microsoft.graph.reactionsFacet"
  },
  "showComments": "Boolean",
  "showRecommendedPages": "Boolean",
  "thumbnailWebUrl": "String",
  "titleArea": {
    "@odata.type": "microsoft.graph.titleArea"
  }
}

Share via