Get SharePoint site page metadata/properties using Graph API beta

Question

Get SharePoint site page metadata/properties using Graph API beta

Gardner, Max 41

Hello!

I'm attempting to retrieve some basic metadata (description, thumbnail) and custom properties for a SharePoint site page using the beta Graph API, but using the basic examples in the documentation isn't giving me all the pieces I need. Specifically, I'm unable to get a description back despite the site having one when editing it through the console. I also cannot get the thumbnail or the custom properties I've set on the page, which seem like they should be coming back as a webPart in the response.

I am hitting endpoint https://graph.microsoft.com/beta/sites/<3-point-id>/pages/<page-id> and getting back:

{  
    &#34;@odata.context&#34;: &#34;https://graph.microsoft.com/beta/$metadata#sites(&lt;site-id&gt;)/pages/$entity&#34;,  
    &#34;eTag&#34;: &#34;&#34;,  
    &#34;id&#34;: &#34;&#34;,  
    &#34;lastModifiedDateTime&#34;: &#34;2020-09-22T20:49:37Z&#34;,  
    &#34;name&#34;: &#34;This-is-a-test-page.aspx&#34;,  
    &#34;webUrl&#34;: &#34;SitePages/This-is-a-test-page.aspx&#34;,  
    &#34;title&#34;: &#34;Testing a title change&#34;,  
    &#34;pageLayout&#34;: &#34;Article&#34;,  
    &#34;createdBy&#34;: {  
        &#34;user&#34;: { }  
    },  
    &#34;lastModifiedBy&#34;: {  
        &#34;user&#34;: { }  
    },  
    &#34;parentReference&#34;: {  
        &#34;siteId&#34;: &#34;&#34;  
    },  
    &#34;contentType&#34;: {  
        &#34;id&#34;: &#34;&#34;,  
        &#34;name&#34;: &#34;Site Page&#34;  
    },  
    &#34;webParts&#34;: [  
        {  
            &#34;type&#34;: &#34;rte&#34;,  
            &#34;data&#34;: {  
                &#34;innerHTML&#34;: &#34;&lt;p&gt;Just something to fill the page and test this out.&lt;/p&gt;&#34;  
            }  
        }  
    ],  
    &#34;publishingState&#34;: {  
        &#34;level&#34;: &#34;published&#34;,  
        &#34;versionId&#34;: &#34;3.0&#34;  
    }  
}

Here's a screenshot of the site's properties in the console:

Any thoughts on how I could return this additional data, such as the description, the page's thumbnail, and the custom properties I've set on the page? I don't see any parameters I can pass in, and I've tried directly selecting at least the description with no success.

JamesTran-MSFT 37,216 Reputation points Microsoft Employee Moderator

2020-09-24T01:23:36.373+00:00
@Gardner, Max
Thanks for your post! Have you tried using the List Pages request?

GET /sites/{site-id}/pages

If you have any other questions, please let me know.
Thank you for your time and patience.
Gardner, Max 41 Reputation points

2020-09-24T14:47:08.24+00:00
Hey James,

I appreciate your response! I have tried the List Pages endpoint as well, and it's returning essentially the same amount of data (no description or additional webParts); also, potentially worth noting, it returns only published pages - no drafts. I've trimmed the response here for char limitation purposes:

{ "name":"This-is-a-test-page.aspx", "title":"Testing a title change", "webParts":[ { "type":"rte", "data":{ "innerHTML":"<p>Just something to fill the page and test this out.</p>" } } ], }

In case it's relevant, the current permissions my app has is Sites.Read.All of type Application.
JamesTran-MSFT 37,216 Reputation points Microsoft Employee Moderator

2020-09-24T21:34:42.717+00:00

@Gardner, Max
Thanks for your details and the quick response.

Since this has to do mainly with SharePoint development with the GraphAPI, I've added the respective SharePoint tags to see if anyone from their team can offer further assistance on your issue.

If you have any other question in the meantime, please let me know.
Thank you for your time!

Answer accepted by question author

0 additional answers

Your answer

JamesTran-MSFT 37,216 Reputation points Microsoft Employee Moderator

2020-09-24T01:23:36.373+00:00

@Gardner, Max
Thanks for your post! Have you tried using the List Pages request?

GET /sites/{site-id}/pages

If you have any other questions, please let me know.
Thank you for your time and patience.
Gardner, Max 41 Reputation points

2020-09-24T14:47:08.24+00:00

Hey James,

I appreciate your response! I have tried the List Pages endpoint as well, and it's returning essentially the same amount of data (no description or additional webParts); also, potentially worth noting, it returns only published pages - no drafts. I've trimmed the response here for char limitation purposes:

{ "name":"This-is-a-test-page.aspx", "title":"Testing a title change", "webParts":[ { "type":"rte", "data":{ "innerHTML":"<p>Just something to fill the page and test this out.</p>" } } ], }

In case it's relevant, the current permissions my app has is Sites.Read.All of type Application.
JamesTran-MSFT 37,216 Reputation points Microsoft Employee Moderator

2020-09-24T21:34:42.717+00:00

@Gardner, Max
Thanks for your details and the quick response.

Since this has to do mainly with SharePoint development with the GraphAPI, I've added the respective SharePoint tags to see if anyone from their team can offer further assistance on your issue.

If you have any other question in the meantime, please let me know.
Thank you for your time!

Answer 1

Hi @Gardner, Max ,

I have a test this endpoint on my SPO, yes it does not return description or some other properties. I think it's by design as it's beta version, the endpoint has not exposed such functionality. Hence i'd like to suggest you submit feedback on Github or turn to the old SharePoint Rest API.

Best Regards,
Baker Kong

If an Answer is helpful, please click "Accept Answer" and upvote it.
Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Share via

Get SharePoint site page metadata/properties using Graph API beta

0 additional answers

Your answer