Microsoft 365 Community SharePoint, 1 Nov 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Introduction to new SharePoint Pages Microsoft Graph API

Description

In this 12-minute developer/designer focused demo, DC Padur steps through the new Microsoft Graph APIs to get, create and manage SharePoint pages (and news posts). Demos showing getting content from specific page, creating page, publishing page as news post, and deleting page. Target use cases, not in scope APIs, and roadmap for PnP/Graph SharePoint APIs called out. Beta API due out at end of November. Please Sign up to test the beta release. This PnP Community demo is taken from the weekly Microsoft 365 Platform Community call recorded on November 1, 2022.

Demo Presenter
• DC Padur (Microsoft) | @dcpadur

Supporting materials
• Article - Announcing the new SharePoint Pages API in Microsoft Graph | aka.ms/PagesAPI
• Beta Testers - SharePoint Pages graph API beta release testers sign up | https://forms.office.com/r/ZgNEgPa54g

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/m365/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/m365/videos
• Microsoft 365 Platform Community - http://aka.ms/m365/community

A

B

Pages API, the modern SharePoint Pages, have been very instrumental in the growth of modern SharePoint experiences and portals in the ux. So we've been Fielding asks for having a decent uh API graph, API endpoint, and it's subject solution right now and we're super excited to for the first time ever have a demo of this functioning API.

B

We just published a blog post that announced this of the functionality in the API, we're hoping to roll out the data by end of November, and then this all you'll see a few recorded demo videos coming hot straight from my onbringing developers deadbox, and this is proof of all the concepts that we are able to show today. So quick review, it's a new graph API to get create and manage their point pages and use posts. It's going to replace the existing beta API.

B

Some of you might be familiar with that, since that beta has been very old. We have a newer data model behind the new API which will be rolling out to GA, and that will be a great existing API experience, but uh we hope to keep improving on the new API and will that we have a rich, exciting roadmap for his teachers.

B

What's in scope, you can get a page, you can get a list of pages. You can create a page or a news course. You can delete a page, and these are all the poor operations, the credit operations that will be available in data if I end up, remember um just to call out before you all ask. What's not in scope is editing an existing page, which is the Tactical adding a web part or adding a section to a specific part of a page. That's not supported news link. Creation is supported.

B

Of course, there might be a few more things that are not supported, but these are the obvious things that we've already sealed as questions, so we just want to call it out, and now we go into our demo time so.

A

The for the scenario.

B

Here is handling my developer. Risk is running the code on very deadbox and working on a local devbox tenant the scenarios around first getting the page content uh of a specific page. Let's listen.

C

First, let's screw down the page on the right side to have an overview. When you want fetch page data, you can call get method on this endpoint, which would return information of a SharePoint page great. Let's expand it to have a better look.

C

Here is a page name, the subnaut image, the page title, training and resources I'd like to cut out the page layout property, which is an article here. But if this page is a home page, it should be a home string. Additionally, there is a property called promotion kind here the page is a normal page, but when the page is a News Post, the value here could have been used. Post Ing. We can see the created and updated information.

C

What's more, we can also see the publishing state. We also have a property called title area refers to the data entitled region in order to access page data content. We can add a query, called expanded, canvas layout and call this endpoint.

C

The page called and storage in the property called canvas layout. Here we get it. However, the window is too small for us to take a look. Let's full screen this tab: okay, great there are Pro 2 properties nested in the canvas layout. One is horizontal sections. The other is vertical section.

C

Let's take a look into the vertical section. First vertical section refer to the vertical section on the right of the page. You can see there are a list of the parts.

C

The first one is a countdown timer, as you can see here.

C

The second one is an event web part, while the third one, and also the last one, is a Twitter web part.

C

Let's back to the page here, we can see here the first one is countdown timer. Second one event and the last one Twitter reports I'd like to cut out there are an additional property called emphasis on the vertical section which refers to the background of this section. Millers, the data structure in horizontal sections are pretty similar.

C

Therefore, with this API, it's easy for us to get page content from any SharePoint pages.

B

Alright, that was the first demo showing how you can get the page content. Given a specific page.

C

The second demo is about copying a page on the right side is the target page. We want to copy call a get method on this endpoint, which would return information of this page, including page content and page metadatas.

C

Here we get the response, expand it to have a better View check, the title and name to confirm this is our Target page.

C

Instead of going through all of the nested data, you can simply copy the whole data and paste it as a payload of requests.

C

When you want to create a new page, called post method on slash, Pages endpoint, don't forget to rename the page here. I will rename it as a bonus-2.

C

Wait for a few seconds great, the page is successfully created. Let's see how the page looks like I will drag this tab to the left of the window. Lovely. So here are the two pages. The left one is the one we just created using the API and the right one is the original one scroll down to have a comparison.

C

We can see the two biggest content are exactly the same. With this feature, it's easy to create a new page with only a few API calls.

C

The most straightforward way is to start from an existing page. Maybe you noticed that there is a post use button on the right top of the page. That's because this page is a News Post, but it isn't published yet back to the home page. The news web part now only has the about us page, but the page we just created using the pages API is not there to make this page public.

C

You can simply call the publish endpoint with the post method back to the page and refresh it we can now see on the top of the page. The status is posted refresh the home page. Our new News Post should be also shown up in the news web part.

B

That was the scenario of creating a page where you initially have the basic page created on the web. You get the page and then make our modifications to the page in terms of title and text content you recreate the page. You can also publish the page as a News Post and see that news posts roll up in the news news web bite. So the last demo is a scenario of Maintenance. Where you get the list of pages. Here's.

C

A demo about deleting page from a site. First I'm gonna cut this endpoint to list all pages on the site. From the right side we can see, there are six pages.

C

The default returning structure has too many properties, which are not clear for us to find some information, therefore I'm going to add a query to select only the name and ID from the result.

C

Let me type it at a cure region, select, ID and name.

C

Here we get it, we can find a page named about us-2.

C

This is a page I created in the last scenario, so I'm gonna copy copy, the page, ID and paste here and I will use a delete method on this page to delete it and wait for a few seconds great. We have a status code 204 and, let's refresh the page to see great, the page is gone.

B

So those were the three quick demos to show to talk about the scenarios that we are supporting. We'd love to hear from you all about what other scenarios you have in mind here. You know in Building Together the various basic credit operations um I as we talked about in the demo.

B

The create ideal creation flow is to make a page and use it as a base to make copies of the page and other scenarios where you get the list of page and you can programmatically have a governance situation where you you know, based on me, one of the metadatas. You can filter out the pages and delete them or archive them in a very different way. So those are some of the scenarios with the imagining would love to hear from you as well uh as I mentioned.

B

Beta release is end of November we'd love to have you all sign up for the Beta release. Testing. uh Of course, beta is open to everyone, but once you sign up on the farm I'm going to paste the link in the chat window here, um it'd be great to have a one-on-one interaction and the akms pages. Api is a quick shot link to the block tools and a place to constantly keep track of what features are being rolled out in that Pages API. That's it for from me.

B

Today, uh I haven't kept up with the API conversations anything else. They said that you want me to address.

A

Yeah before we come on come forward, I think it's good to elaborate that, because there was a discussion related on what is the this objective to replace the BMP Pages API, which is widely being used by this work, and- and is this going to support all of those different scenarios? And do you want me to answer or do you want to answer either way.

B

uh You you know enough, you should go. Your voice is bad boy. Okay,.

A

Thank you so there's a lot of learning from the PMP Pages API, which has existed for a while and now we're adapting a lot of those uh learnings directly to provide the Microsoft craft. Pages API, ultimately objective is to support all of the different same scenarios as we support natively within a ux or within the pnb pages API within a graph API. Now, let's face it, this will be a journey.

A

uh The beta version will not be as fully complete and with all of the features, as we have within the pages PMP API side, as this is rolling out the beta, but based on the feedback based on the input. We'll, add new capabilities within a graph API for sure ultimate objective. However, just to repeat is to make sure that the graph API for SharePoint pages is The API, which has alternate capabilities, and you don't need to use anything else, good way of saying that they say.

B

Absolutely I was glad to hear it in your words.

A

I didn't want to promise anything from your side on the on.

B

A

B

A

B

Yes, yeah definitely a journey we're starting we're committing to uh uh the 1.0 rollout very soon and we'll keep it constantly trading on the API and get to uh parity and even more yeah.

A

Excellent thanks DC on that one.