pageTemplate resource type
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.
Represents a page template in the templates folder.
In addition to other properties, a pageTemplate resource contains the title, layout, and a collection of webPart objects.
Inherits from baseSitePage.
Methods
| Method | Return type | Description |
|---|---|---|
| List | pageTemplate | Get a list of the pageTemplate objects and their properties. |
| Create | pageTemplate | Create a new pageTemplate object. |
| Get | pageTemplate | Get a pageTemplate object and properties. |
| Update | pageTemplate | Update the properties of a pageTemplate object. |
| Delete | None | Delete a pageTemplate object. |
Properties
| Property | Type | Description |
|---|---|---|
| contentType | contentTypeInfo | The content type of the page template. Inherited from baseSitePage. |
| createdBy | identitySet | The identity of the creator of the page template. Read-only. Inherited from baseSitePage. |
| createdDateTime | DateTimeOffset | The date and time the page template was created. Read-only. Inherited from baseSitePage. |
| description | String | The descriptive text for the page template. Inherited from baseSitePage. |
| eTag | String | The eTag for the page template. Inherited from baseSitePage. |
| id | String | The unique identifier of the page template. Inherited from baseSitePage. |
| lastModifiedBy | identitySet | The identity of the last modifier of the page template. Read-only. Inherited from baseSitePage. |
| lastModifiedDateTime | DateTimeOffset | The date and time the page template was last modified. Read-only. Inherited from baseSitePage. |
| name | String | The name of the page template. Inherited from baseSitePage. |
| pageLayout | pageLayoutType | The type of the page layout for the page. The possible values are: microsoftReserved, article, home, unknownFutureValue, newsLink. You must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: newsLink. Inherited from baseSitePage. |
| parentReference | itemReference | The parent information, if the page template has a parent. Inherited from baseSitePage. |
| publishingState | publicationFacet | The publishing status and the MM.mm version of the page template. Inherited from baseSitePage. |
| thumbnailWebUrl | String | The URL of the page template's thumbnail image |
| title | String | The title of the page template. Inherited from baseSitePage. |
| titleArea | titleArea | The title area on the SharePoint page template. |
| webUrl | String | The URL that displays the page template in the browser. Read-only. Inherited from baseSitePage. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| canvasLayout | canvasLayout | The layout of the content in a given SharePoint page template, including horizontal sections and vertical sections. |
| createdByUser | user | The identity of the user who created this site page template. Read-only. Inherited from baseSitePage. |
| lastModifiedByUser | user | The identity of the last modifier of this item. Read-only. Inherited from baseSitePage. |
| webParts | webPart collection | The collection of web parts on the SharePoint page. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.pageTemplate",
"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",
"publishingState": {
"@odata.type": "microsoft.graph.publicationFacet"
},
"thumbnailWebUrl": "String",
"titleArea": {
"@odata.type": "microsoft.graph.titleArea"
}
}