Create verticalSection

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.

Create a verticalSection object in a given sitePage.

A sitePage can only have one vertical section. If a vertical section already exists, this method returns a 409 Conflict response code.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Sites.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Sites.ReadWrite.All	Not available.

HTTP request

PUT /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the verticalSection resource to create.

Response

If successful, this method returns a 201 Created response code and a created verticalSection object in the response body.

If the vertical section already exists, this method returns a 409 Conflict response code.

Examples

Request

The following example shows a request.

HTTP

PUT https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/verticalSection
Content-Type: application/json

{
  "emphasis": "soft",
  "webparts":[
    {
      "id":"20a69b85-529c-41f3-850e-c93458aa74eb",
      "innerHtml":"<p>sample text in text web part</p>"
    }
  ]
}

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

VerticalSection verticalSection = new VerticalSection();
verticalSection.emphasis = SectionEmphasisType.SOFT;
LinkedList<WebPart> webpartsList = new LinkedList<WebPart>();
WebPart webparts = new WebPart();
webparts.id = "20a69b85-529c-41f3-850e-c93458aa74eb";
webparts.innerHtml = "<p>sample text in text web part</p>";
webpartsList.add(webparts);
WebPartCollectionResponse webPartCollectionResponse = new WebPartCollectionResponse();
webPartCollectionResponse.value = webpartsList;
WebPartCollectionPage webPartCollectionPage = new WebPartCollectionPage(webPartCollectionResponse, null);
verticalSection.webparts = webPartCollectionPage;

graphClient.sites("{site-id}").pages("{page-id}").canvasLayout().verticalSection()
	.buildRequest()
	.put(verticalSection);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const verticalSection = {
  emphasis: 'soft',
  webparts: [
    {
      id: '20a69b85-529c-41f3-850e-c93458aa74eb',
      innerHtml: '<p>sample text in text web part</p>'
    }
  ]
};

await client.api('/sites/{site-id}/pages/{page-id}/canvasLayout/verticalSection')
	.version('beta')
	.put(verticalSection);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "emphasis": "soft",
  "webparts":[
    {
      "id":"20a69b85-529c-41f3-850e-c93458aa74eb",
      "innerHtml":"<p>sample text in text web part</p>"
    }
  ]
}