Updating a webpart in a site page which has the vertical section using Graph API

Question

Updating a webpart in a site page which has the vertical section using Graph API

KosakaTomoya-3980 25

I am using the Microsoft Graph API to modify a site page in a modern team site using the following

https://learn.microsoft.com/en-us/graph/api/webpart-update?view=graph-rest-1.0

I request the following in an attempt to update a webpart.

PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/webParts/{webpart-id}
PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts/{webpart-index}
PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts/{webpart-index}

At first I try to update a site page which has no vertical section. And the request works well.

Next, I try to update a site page which had the vertical section. And the response has the following error.

{
    "error": {
        "code": "invalidRequest",
        "message": "Cannot have vertical section and full width horizontal section at the same time",
        "innerError": {
            "code": "badArgument",
            "date": "2024-10-12T12:28:29",
            "request-id": "aac28419-9eca-41f9-8d68-669457368034",
            "client-request-id": "6588f432-9aae-6681-c96c-faf7fb2e5380"
        }
    }
}

The page has a webpart for the page title, which is a full width layout within the horizontal section, which is also present on all other pages.

I can create and modify the following page in my browser. But I can not modify the same page with Graph API. The page with the vertical section

Any pointers are appreciated.

Accepted answer

1 additional answer

Your answer

Answer 1

Xyza Xue_MSFT 30,176 Microsoft External Staff

Hi @KosakaTomoya-3980 ,

The error message you are encountering indicates that the page cannot have both a vertical section and a full-width horizontal section simultaneously. This limitation is enforced by the Microsoft Graph API when updating site pages.This is a limitation within the Microsoft Graph API when dealing with site pages that have specific layout configurations.

To resolve this issue, you should ensure that your page layout does not include both types of sections simultaneously. If you need to maintain a vertical section, consider removing or modifying the full-width horizontal section before attempting to update the web part.

You can create and modify pages in the browser, but the Graph API enforces these layout rules strictly, which may lead to such errors.

If the answer is helpful, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

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.

KosakaTomoya-3980 25 Reputation points

2024-10-14T16:12:44.7633333+00:00

#deleted
KosakaTomoya-3980 25 Reputation points

2024-10-14T16:28:29.5833333+00:00

Hi @Xyza Xue_MSFT ,

Thank you for your response.

To resolve this issue, you should ensure that your page layout does not include both types of sections simultaneously. If you need to maintain a vertical section, consider removing or modifying the full-width horizontal section before attempting to update the web part.

It became clear to me that there is no solution that uses only the Microsoft Graph API. I will either develop an update procedure for pages affected by the limitation, or develop pages that are not affected.

And,,,

This is a limitation within the Microsoft Graph API when dealing with site pages that have specific layout configurations.

Are you saying this is a limitation in the current Microsoft Graph API release and I can expect it to be removed in the future?

The reason I ask is that I have not been able to find any official documentation describing this limitation. For example, the following document is available. However, the limitations described here are for SharePoint Online, not the Microsoft Graph API. And The document says "you can't have a full-width column and a vertical section on the same page", but in fact "we can have a full-width column at the top of the page and a vertical section on the same page".

Add sections and columns on a SharePoint modern page (updated)
Xyza Xue_MSFT 30,176 Reputation points Microsoft External Staff

2024-10-15T06:35:21.5433333+00:00
Hi @KosakaTomoya-3980 ,

It became clear to me that there is no solution that uses only the Microsoft Graph API. I will either develop an update procedure for pages affected by the limitation, or develop pages that are not affected.

That's exactly it.

However, the limitations described here are for SharePoint Online, not the Microsoft Graph API. And The document says "you can't have a full-width column and a vertical section on the same page", but in fact "we can have a full-width column at the top of the page and a vertical section on the same page".

There really isn't any official documentation for the Microsoft Graph API that describes this limitation. The SharePoint Online documentation says “you can't have a full-width column and a vertical section on the same page “. This limitation did exist before (the documentation was updated in June 2023), and after my testing, it is indeed now possible to have both. But there is no official documentation on this either. Regarding the restrictions in Graph. We sincerely recommend you go to Feedback community to provide your feedback:Community(microsoft.com). This is the best platform to let related team hear from you and make the products and services better for you and others.

If the answer is helpful, please click "Accept Answer"
KosakaTomoya-3980 25 Reputation points

2024-10-15T14:49:48.8033333+00:00
Hi ,Thank you again!
Your answers are very helpful for me.

By the way, I may have found a way around this limitation.

Create or modify a page which has full-width column at the top of the page and a vertical section in the browser.

Get the page with Microsoft Graph API.

Convert the webpart which is full-width column at the top of the page to titleArea resource type and update the page with Microsoft Graph API.

Then you can update a webpart with the Microsoft Graph API.

The editor converts the titleArea resource type to the webpart, so once you modify the page in the browser, start over from step 2.

I followed your recommendation and provided a feedback.

Hopefully Microsoft Graph API will catch up with the editor's specifications soon.

Answer 2

The error message you received indicates that a site page cannot have both a vertical section and a full-width horizontal section at the same time. This limitation is likely due to the layout constraints of modern SharePoint pages, which dictate that certain section types cannot coexist.

To resolve this issue, you should ensure that your page's layout is consistent with the types of sections you are trying to implement. If you want to use a vertical section, make sure that the page does not include any full-width horizontal sections. Alternatively, if you need a full-width layout, consider restructuring the page to avoid using vertical sections.

For further assistance, you may want to review the specific requirements and limitations regarding section layouts in modern SharePoint pages.

References:

Share via

Updating a webpart in a site page which has the vertical section using Graph API

1 additional answer

Your answer