Actions

The ballerinax/microsoft.sharepoint.pages package exposes the following clients:

Client	Purpose
`Client`	Manage SharePoint site pages, canvas layouts, horizontal and vertical sections, web parts, and page metadata through the Microsoft Graph v1.0 API

Client

Provides operations to create, read, update, delete, and publish SharePoint site pages, canvas layouts, horizontal and vertical sections, and web parts through the Microsoft Graph v1.0 API.

Configuration

ConnectionConfig

Field	Type	Default	Description
`auth`	`OAuth2ClientCredentialsGrantConfig\|http:BearerTokenConfig\|OAuth2RefreshTokenGrantConfig`	Required	Configurations related to client authentication
`httpVersion`	`http:HttpVersion`	`http:HTTP_2_0`	The HTTP version understood by the client
`http1Settings`	`http:ClientHttp1Settings`	`{}`	Configurations related to HTTP/1.x protocol
`http2Settings`	`http:ClientHttp2Settings`	`{}`	Configurations related to HTTP/2 protocol
`timeout`	`decimal`	`30`	The maximum time to wait (in seconds) for a response before closing the connection
`forwarded`	`string`	`"disable"`	The choice of setting `forwarded`/`x-forwarded` header
`followRedirects`	`http:FollowRedirects`	—	Configurations associated with redirection
`poolConfig`	`http:PoolConfiguration`	—	Configurations associated with request pooling
`cache`	`http:CacheConfig`	`{}`	HTTP caching related configurations
`compression`	`http:Compression`	`http:COMPRESSION_AUTO`	Specifies the way of handling compression (`accept-encoding`) header
`circuitBreaker`	`http:CircuitBreakerConfig`	—	Configurations associated with the behaviour of the Circuit Breaker
`retryConfig`	`http:RetryConfig`	—	Configurations associated with retrying
`cookieConfig`	`http:CookieConfig`	—	Configurations associated with cookies
`responseLimits`	`http:ResponseLimitConfigs`	`{}`	Configurations associated with inbound response size limits
`secureSocket`	`http:ClientSecureSocket`	—	SSL/TLS-related options
`proxy`	`http:ProxyConfig`	—	Proxy server related options
`socketConfig`	`http:ClientSocketConfig`	`{}`	Provides settings related to client socket configuration
`validation`	`boolean`	`true`	Enables the inbound payload validation functionality provided by the constraint package
`laxDataBinding`	`boolean`	`true`	Enables relaxed data binding on the client side

OAuth2ClientCredentialsGrantConfig (extends http:OAuth2ClientCredentialsGrantConfig)

Field	Type	Default	Description
`tokenUrl`	`string`	`https://login.microsoftonline.com/<TENANT_ID>/oauth2/v2.0/token`	The token endpoint URL for OAuth2 client credentials grant

Initializing the client

import ballerinax/microsoft.sharepoint.pages;

pages:ConnectionConfig config = {
    auth: {
        clientId: "<clientId>",
        clientSecret: "<clientSecret>",
        tokenUrl: "https://login.microsoftonline.com/<tenantId>/oauth2/v2.0/token",
        scopes: ["https://graph.microsoft.com/.default"]
    }
};
pages:Client sharepointClient = check new (config);

Operations

Page Management

listPages

Lists all base site pages in the pages list of a site.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListPagesQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: BaseSitePageCollectionResponse|error

Sample code:

pages:BaseSitePageCollectionResponse result = check client->listPages("site-id");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites('site-id')/pages",
  "value": [
    {
      "id": "page-id-1",
      "name": "home.aspx",
      "title": "Home",
      "webUrl": "https://contoso.sharepoint.com/SitePages/home.aspx",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "lastModifiedDateTime": "2024-06-01T08:30:00Z"
    }
  ]
}

createPages

Creates a page in the site pages list of a site.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`payload`	`BaseSitePage`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: BaseSitePage|error

Sample code:

pages:BaseSitePage payload = {
    name: "new-page.aspx",
    title: "New Page"
};
pages:BaseSitePage result = check client->createPages("site-id", payload);

Sample response:

{
  "id": "page-id-2",
  "name": "new-page.aspx",
  "title": "New Page",
  "webUrl": "https://contoso.sharepoint.com/SitePages/new-page.aspx",
  "createdDateTime": "2024-06-11T10:00:00Z",
  "lastModifiedDateTime": "2024-06-11T10:00:00Z"
}

getPages

Retrieves the metadata of a base site page by its identifier.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPagesQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: BaseSitePage|error

Sample code:

pages:BaseSitePage result = check client->getPages("site-id", "page-id-1");

Sample response:

{
  "id": "page-id-1",
  "name": "home.aspx",
  "title": "Home",
  "webUrl": "https://contoso.sharepoint.com/SitePages/home.aspx",
  "createdDateTime": "2024-01-15T10:00:00Z",
  "lastModifiedDateTime": "2024-06-01T08:30:00Z"
}

deletePages

Deletes a base site page from the site pages list.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`DeletePagesHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deletePages("site-id", "page-id-1");

updatePages

Updates the navigation property pages in sites with new property values.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`BaseSitePage`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:BaseSitePage payload = {title: "Updated Home"};
check client->updatePages("site-id", "page-id-1", payload);

getPagesCount

Gets the total count of base site pages in the pages list of a site.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPagesCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getPagesCount("site-id");

Sample response:

"5"

listSitePages

Lists all SitePage-typed pages in the site pages list of a site.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListSitePagesQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: SitePageCollectionResponse|error

Sample code:

pages:SitePageCollectionResponse result = check client->listSitePages("site-id");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites('site-id')/pages/microsoft.graph.sitePage",
  "value": [
    {
      "id": "page-id-1",
      "@odata.type": "#microsoft.graph.sitePage",
      "name": "home.aspx",
      "title": "Home",
      "pageLayout": "article",
      "promotionKind": "page",
      "webUrl": "https://contoso.sharepoint.com/SitePages/home.aspx"
    }
  ]
}

getSitePagesCount

Gets the total count of SitePage-typed pages in the pages list of a site.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePagesCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getSitePagesCount("site-id");

Sample response:

"3"

Site Page Operations

getSitePage

Retrieves the full SitePage entity, including canvas layout details, for a specific page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: SitePage|error

Sample code:

pages:SitePage result = check client->getSitePage("site-id", "page-id-1");

Sample response:

{
  "id": "page-id-1",
  "@odata.type": "#microsoft.graph.sitePage",
  "name": "home.aspx",
  "title": "Home",
  "pageLayout": "article",
  "promotionKind": "page",
  "webUrl": "https://contoso.sharepoint.com/SitePages/home.aspx",
  "createdDateTime": "2024-01-15T10:00:00Z",
  "lastModifiedDateTime": "2024-06-01T08:30:00Z"
}

publishSitePage

Publishes a site page, making it publicly visible to site members.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->publishSitePage("site-id", "page-id-1");

getSitePageWebPartsByPosition

Retrieves web parts from a site page filtered by their position within the canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageWebPartsByPositionQueries`	No	OData query parameters for position-based filtering

Returns: WebPartCollectionResponse|error

Sample code:

pages:WebPartCollectionResponse result = check client->getSitePageWebPartsByPosition("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.webPart)",
  "value": [
    {
      "id": "webpart-id-1",
      "@odata.type": "#microsoft.graph.textWebPart",
      "innerHtml": "<p>Welcome to our intranet!</p>"
    }
  ]
}

Canvas Layout

getSitePageCanvasLayout

Retrieves the canvas layout of a site page, including its horizontal and vertical sections.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageCanvasLayoutQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: CanvasLayout|error

Sample code:

pages:CanvasLayout result = check client->getSitePageCanvasLayout("site-id", "page-id-1");

Sample response:

{
  "horizontalSections": [
    {
      "id": "1",
      "emphasis": "none",
      "layout": "oneColumn"
    }
  ],
  "verticalSection": {
    "emphasis": "soft"
  }
}

deleteSitePageCanvasLayout

Deletes the canvas layout navigation property from a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`DeleteSitePageCanvasLayoutHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteSitePageCanvasLayout("site-id", "page-id-1");

updateSitePageCanvasLayout

Updates the canvas layout navigation property in sites with new section and column configuration.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`CanvasLayout`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:CanvasLayout payload = {
    horizontalSections: [
        {
            id: "last-reviewed-section",
            emphasis: "strong",
            columns: [
                {id: "col-1", width: 12, webparts: [{id: "wp-1"}]}
            ]
        }
    ]
};
check client->updateSitePageCanvasLayout("site-id", "page-id-1", payload);

Horizontal Section Management

listHorizontalSections

Lists all horizontal sections in the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListHorizontalSectionsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: HorizontalSectionCollectionResponse|error

Sample code:

pages:HorizontalSectionCollectionResponse result = check client->listHorizontalSections("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "id": "1",
      "emphasis": "none",
      "layout": "oneColumn"
    },
    {
      "id": "2",
      "emphasis": "strong",
      "layout": "twoColumns"
    }
  ]
}

createHorizontalSection

Creates a new horizontal section in the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`HorizontalSection`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: HorizontalSection|error

Sample code:

pages:HorizontalSection payload = {
    id: "new-section",
    emphasis: "strong",
    columns: [{id: "col-1", width: 12}]
};
pages:HorizontalSection result = check client->createHorizontalSection("site-id", "page-id-1", payload);

Sample response:

{
  "id": "new-section",
  "emphasis": "strong",
  "layout": "oneColumn",
  "columns": [
    {
      "id": "col-1",
      "width": 12
    }
  ]
}

getHorizontalSection

Retrieves a specific horizontal section from the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHorizontalSectionQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: HorizontalSection|error

Sample code:

pages:HorizontalSection result = check client->getHorizontalSection("site-id", "page-id-1", "section-id-1");

Sample response:

{
  "id": "1",
  "emphasis": "none",
  "layout": "oneColumn",
  "columns": [
    {
      "id": "col-1",
      "width": 12
    }
  ]
}

deleteHorizontalSection

Deletes a horizontal section navigation property from the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`headers`	`DeleteHorizontalSectionHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteHorizontalSection("site-id", "page-id-1", "section-id-1");

updateHorizontalSection

Updates the navigation property horizontalSections in sites with new property values.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`payload`	`HorizontalSection`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:HorizontalSection payload = {emphasis: "soft"};
check client->updateHorizontalSection("site-id", "page-id-1", "section-id-1", payload);

getHSectionsCount

Gets the total count of horizontal sections in the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHSectionsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getHSectionsCount("site-id", "page-id-1");

Sample response:

"2"

Horizontal Section Column Management

listHSectionColumns

Lists all columns in a specific horizontal section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListHSectionColumnsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: HorizontalSectionColumnCollectionResponse|error

Sample code:

pages:HorizontalSectionColumnCollectionResponse result = check client->listHSectionColumns("site-id", "page-id-1", "section-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "id": "col-1",
      "width": 6
    },
    {
      "id": "col-2",
      "width": 6
    }
  ]
}

createHSectionColumn

Creates a new column in a specific horizontal section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`payload`	`HorizontalSectionColumn`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: HorizontalSectionColumn|error

Sample code:

pages:HorizontalSectionColumn payload = {id: "new-col", width: 12};
pages:HorizontalSectionColumn result = check client->createHSectionColumn("site-id", "page-id-1", "section-id-1", payload);

Sample response:

{
  "id": "new-col",
  "width": 12
}

getHSectionColumn

Retrieves a specific column from a horizontal section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHSectionColumnQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: HorizontalSectionColumn|error

Sample code:

pages:HorizontalSectionColumn result = check client->getHSectionColumn("site-id", "page-id-1", "section-id-1", "col-id-1");

Sample response:

{
  "id": "col-id-1",
  "width": 6
}

deleteHSectionColumn

Deletes a column navigation property from a horizontal section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`headers`	`DeleteHSectionColumnHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteHSectionColumn("site-id", "page-id-1", "section-id-1", "col-id-1");

updateHSectionColumn

Updates the navigation property columns in sites with new property values for a specific horizontal section column.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`payload`	`HorizontalSectionColumn`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:HorizontalSectionColumn payload = {width: 4};
check client->updateHSectionColumn("site-id", "page-id-1", "section-id-1", "col-id-1", payload);

getHSectionColumnsCount

Gets the total count of columns in a specific horizontal section of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHSectionColumnsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getHSectionColumnsCount("site-id", "page-id-1", "section-id-1");

Sample response:

"2"

Horizontal Section Column Web Part Management

listHSectionColumnWebparts

Lists all web parts in a specific column of a horizontal section in a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListHSectionColumnWebpartsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: WebPartCollectionResponse|error

Sample code:

pages:WebPartCollectionResponse result = check client->listHSectionColumnWebparts("site-id", "page-id-1", "section-id-1", "col-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "id": "webpart-id-1",
      "@odata.type": "#microsoft.graph.textWebPart",
      "innerHtml": "<p>Hello World</p>"
    }
  ]
}

createHSectionColumnWebpart

Creates a new web part in a specific column of a horizontal section in a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`payload`	`WebPart`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPart|error

Sample code:

pages:WebPart payload = {id: "new-webpart"};
pages:WebPart result = check client->createHSectionColumnWebpart("site-id", "page-id-1", "section-id-1", "col-id-1", payload);

Sample response:

{
  "id": "new-webpart",
  "@odata.type": "#microsoft.graph.textWebPart"
}

getHSectionColumnWebpart

Retrieves a specific web part from a column in a horizontal section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHSectionColumnWebpartQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: WebPart|error

Sample code:

pages:WebPart result = check client->getHSectionColumnWebpart("site-id", "page-id-1", "section-id-1", "col-id-1", "webpart-id-1");

Sample response:

{
  "id": "webpart-id-1",
  "@odata.type": "#microsoft.graph.textWebPart",
  "innerHtml": "<p>Hello World</p>"
}

deleteHSectionColumnWebpart

Deletes a web part navigation property from a column in a horizontal section of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`DeleteHSectionColumnWebpartHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteHSectionColumnWebpart("site-id", "page-id-1", "section-id-1", "col-id-1", "webpart-id-1");

updateHSectionColumnWebpart

Updates the navigation property webparts in sites with new property values for a specific horizontal section column web part.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`webPartId`	`string`	Yes	The unique identifier of the webPart
`payload`	`WebPart`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:WebPart payload = {id: "webpart-id-1"};
check client->updateHSectionColumnWebpart("site-id", "page-id-1", "section-id-1", "col-id-1", "webpart-id-1", payload);

getHSectionColumnWebpartPosition

Invokes the getPositionOfWebPart action to retrieve the position details of a web part within a horizontal section column.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPartPositionResponse|error

Sample code:

pages:WebPartPositionResponse result = check client->getHSectionColumnWebpartPosition("site-id", "page-id-1", "section-id-1", "col-id-1", "webpart-id-1");

Sample response:

{
  "columnId": "col-id-1",
  "horizontalSectionId": "section-id-1",
  "isInVerticalSection": false,
  "webPartIndex": 0
}

getHSectionColumnWebpartsCount

Gets the total count of web parts in a specific horizontal section column of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`horizontalSectionId`	`string`	Yes	The unique identifier of the horizontalSection
`horizontalSectionColumnId`	`string`	Yes	The unique identifier of the horizontalSectionColumn
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetHSectionColumnWebpartsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getHSectionColumnWebpartsCount("site-id", "page-id-1", "section-id-1", "col-id-1");

Sample response:

"3"

Vertical Section Management

getVerticalSection

Retrieves the vertical section from the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetVerticalSectionQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: VerticalSection|error

Sample code:

pages:VerticalSection result = check client->getVerticalSection("site-id", "page-id-1");

Sample response:

{
  "emphasis": "soft",
  "webparts": [
    {
      "id": "webpart-id-1",
      "@odata.type": "#microsoft.graph.textWebPart"
    }
  ]
}

deleteVerticalSection

Deletes the vertical section navigation property from the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`DeleteVerticalSectionHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteVerticalSection("site-id", "page-id-1");

updateVerticalSection

Updates the navigation property verticalSection in sites with new property values.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`VerticalSection`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:VerticalSection payload = {emphasis: "strong"};
check client->updateVerticalSection("site-id", "page-id-1", payload);

Vertical Section Web Part Management

listVSectionWebparts

Lists all web parts in the vertical section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListVSectionWebpartsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: WebPartCollectionResponse|error

Sample code:

pages:WebPartCollectionResponse result = check client->listVSectionWebparts("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "id": "webpart-id-1",
      "@odata.type": "#microsoft.graph.textWebPart",
      "innerHtml": "<p>Vertical section content</p>"
    }
  ]
}

createVSectionWebpart

Creates a new web part in the vertical section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`WebPart`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPart|error

Sample code:

pages:WebPart newWebPart = {id: "new-announcement-webpart"};
pages:WebPart result = check client->createVSectionWebpart("site-id", "page-id-1", newWebPart);

Sample response:

{
  "id": "new-announcement-webpart",
  "@odata.type": "#microsoft.graph.textWebPart"
}

getVSectionWebpart

Retrieves a specific web part from the vertical section of a site page's canvas layout.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetVSectionWebpartQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: WebPart|error

Sample code:

pages:WebPart result = check client->getVSectionWebpart("site-id", "page-id-1", "webpart-id-1");

Sample response:

{
  "id": "webpart-id-1",
  "@odata.type": "#microsoft.graph.textWebPart",
  "innerHtml": "<p>Vertical section content</p>"
}

deleteVSectionWebpart

Deletes a web part navigation property from the vertical section of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`DeleteVSectionWebpartHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteVSectionWebpart("site-id", "page-id-1", "webpart-id-1");

updateVSectionWebpart

Updates the navigation property webparts in the vertical section of a site page with new property values.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`payload`	`WebPart`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:WebPart updatedWebPart = {id: "webpart-id-1"};
check client->updateVSectionWebpart("site-id", "page-id-1", "webpart-id-1", updatedWebPart);

getVSectionWebpartPosition

Invokes the getPositionOfWebPart action to retrieve the position details of a web part within the vertical section.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPartPositionResponse|error

Sample code:

pages:WebPartPositionResponse result = check client->getVSectionWebpartPosition("site-id", "page-id-1", "webpart-id-1");

Sample response:

{
  "columnId": null,
  "horizontalSectionId": null,
  "isInVerticalSection": true,
  "webPartIndex": 0
}

getVSectionWebpartsCount

Gets the total count of web parts in the vertical section of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetVSectionWebpartsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getVSectionWebpartsCount("site-id", "page-id-1");

Sample response:

"2"

Site Page Web Part Management

listSitePageWebParts

Lists all web parts associated with a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListSitePageWebPartsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: WebPartCollectionResponse|error

Sample code:

pages:WebPartCollectionResponse result = check client->listSitePageWebParts("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "id": "webpart-id-1",
      "@odata.type": "#microsoft.graph.textWebPart",
      "innerHtml": "<p>Welcome to our intranet!</p>"
    },
    {
      "id": "webpart-id-2",
      "@odata.type": "#microsoft.graph.standardWebPart",
      "webPartType": "d1d91016-032f-456d-98a4-721247c305e8"
    }
  ]
}

createSitePageWebPart

Creates a new web part and associates it with a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`WebPart`	Yes	New navigation property
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPart|error

Sample code:

pages:WebPart payload = {id: "new-webpart"};
pages:WebPart result = check client->createSitePageWebPart("site-id", "page-id-1", payload);

Sample response:

{
  "id": "new-webpart",
  "@odata.type": "#microsoft.graph.textWebPart"
}

getSitePageWebPart

Retrieves a specific web part from a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageWebPartQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: WebPart|error

Sample code:

pages:WebPart result = check client->getSitePageWebPart("site-id", "page-id-1", "webpart-id-1");

Sample response:

{
  "id": "webpart-id-1",
  "@odata.type": "#microsoft.graph.textWebPart",
  "innerHtml": "<p>Welcome to our intranet!</p>"
}

deleteSitePageWebPart

Deletes a web part from a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`DeleteSitePageWebPartHeaders`	No	Headers to be sent with the request (supports `If-Match` ETag)

Returns: error?

Sample code:

check client->deleteSitePageWebPart("site-id", "page-id-1", "webpart-id-1");

updateSitePageWebPart

Updates the navigation property webParts in sites with new property values for a specific site page web part.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`payload`	`WebPart`	Yes	New navigation property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:WebPart payload = {id: "webpart-id-1"};
check client->updateSitePageWebPart("site-id", "page-id-1", "webpart-id-1", payload);

getSitePageWebPartPosition

Invokes the getPositionOfWebPart action to retrieve the position of a web part within the canvas layout of a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`webPartId`	`string`	Yes	The unique identifier of the webPart
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: WebPartPositionResponse|error

Sample code:

pages:WebPartPositionResponse result = check client->getSitePageWebPartPosition("site-id", "page-id-1", "webpart-id-1");

Sample response:

{
  "columnId": "col-id-1",
  "horizontalSectionId": "section-id-1",
  "isInVerticalSection": false,
  "webPartIndex": 1
}

getSitePageWebPartsCount

Gets the total count of web parts associated with a site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageWebPartsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getSitePageWebPartsCount("site-id", "page-id-1");

Sample response:

"4"

User Metadata (Base Site Page)

getPageCreator

Retrieves the user who created a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageCreatorQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: User|error

Sample code:

pages:User result = check client->getPageCreator("site-id", "page-id-1");

Sample response:

{
  "id": "user-id-1",
  "displayName": "John Doe",
  "userPrincipalName": "[email protected]",
  "mail": "[email protected]"
}

getPageCreatorMailbox

Retrieves the mailbox settings of the user who created a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageCreatorMailboxQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: MailboxSettings|error

Sample code:

pages:MailboxSettings result = check client->getPageCreatorMailbox("site-id", "page-id-1");

Sample response:

{
  "timeZone": "Pacific Standard Time",
  "language": {
    "locale": "en-US",
    "displayName": "English (United States)"
  },
  "automaticRepliesSetting": {
    "status": "disabled"
  }
}

updatePageCreatorMailbox

Updates the mailbox settings property value of the user who created a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`MailboxSettings`	Yes	New property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:MailboxSettings payload = {timeZone: "Eastern Standard Time"};
check client->updatePageCreatorMailbox("site-id", "page-id-1", payload);

listPageCreatorServiceErrors

Retrieves the service provisioning errors for the user who created a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListPageCreatorServiceErrorsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: ServiceProvisioningErrorCollectionResponse|error

Sample code:

pages:ServiceProvisioningErrorCollectionResponse result = check client->listPageCreatorServiceErrors("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": [
    {
      "createdDateTime": "2024-01-01T00:00:00Z",
      "isResolved": false,
      "serviceInstance": "exchange"
    }
  ]
}

getPageCreatorServiceErrorsCount

Gets the total count of service provisioning errors for the user who created a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageCreatorServiceErrorsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getPageCreatorServiceErrorsCount("site-id", "page-id-1");

Sample response:

"0"

getPageModifier

Retrieves the user who last modified a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageModifierQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: User|error

Sample code:

pages:User result = check client->getPageModifier("site-id", "page-id-1");

Sample response:

{
  "id": "user-id-2",
  "displayName": "Jane Smith",
  "userPrincipalName": "[email protected]",
  "mail": "[email protected]"
}

getPageModifierMailbox

Retrieves the mailbox settings of the user who last modified a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageModifierMailboxQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: MailboxSettings|error

Sample code:

pages:MailboxSettings result = check client->getPageModifierMailbox("site-id", "page-id-1");

Sample response:

{
  "timeZone": "Eastern Standard Time",
  "language": {
    "locale": "en-US",
    "displayName": "English (United States)"
  },
  "automaticRepliesSetting": {
    "status": "disabled"
  }
}

updatePageModifierMailbox

Updates the mailbox settings property value of the user who last modified a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`MailboxSettings`	Yes	New property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:MailboxSettings payload = {timeZone: "Pacific Standard Time"};
check client->updatePageModifierMailbox("site-id", "page-id-1", payload);

listPageModifierServiceErrors

Retrieves the service provisioning errors for the user who last modified a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListPageModifierServiceErrorsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: ServiceProvisioningErrorCollectionResponse|error

Sample code:

pages:ServiceProvisioningErrorCollectionResponse result = check client->listPageModifierServiceErrors("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": []
}

getPageModifierServiceErrorsCount

Gets the total count of service provisioning errors for the user who last modified a base site page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetPageModifierServiceErrorsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getPageModifierServiceErrorsCount("site-id", "page-id-1");

Sample response:

"0"

User Metadata (Site Page)

getSitePageCreator

Retrieves the user who created a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageCreatorQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: User|error

Sample code:

pages:User result = check client->getSitePageCreator("site-id", "page-id-1");

Sample response:

{
  "id": "user-id-1",
  "displayName": "John Doe",
  "userPrincipalName": "[email protected]",
  "mail": "[email protected]"
}

getSitePageCreatorMailbox

Retrieves the mailbox settings of the user who created a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageCreatorMailboxQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: MailboxSettings|error

Sample code:

pages:MailboxSettings result = check client->getSitePageCreatorMailbox("site-id", "page-id-1");

Sample response:

{
  "timeZone": "Pacific Standard Time",
  "language": {
    "locale": "en-US",
    "displayName": "English (United States)"
  },
  "automaticRepliesSetting": {
    "status": "disabled"
  }
}

updateSitePageCreatorMailbox

Updates the mailbox settings property value of the user who created a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`MailboxSettings`	Yes	New property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:MailboxSettings payload = {timeZone: "Central Standard Time"};
check client->updateSitePageCreatorMailbox("site-id", "page-id-1", payload);

listSitePageCreatorServiceErrors

Retrieves the service provisioning errors for the user who created a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListSitePageCreatorServiceErrorsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: ServiceProvisioningErrorCollectionResponse|error

Sample code:

pages:ServiceProvisioningErrorCollectionResponse result = check client->listSitePageCreatorServiceErrors("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": []
}

getSitePageCreatorServiceErrorsCount

Gets the total count of service provisioning errors for the user who created a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageCreatorServiceErrorsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getSitePageCreatorServiceErrorsCount("site-id", "page-id-1");

Sample response:

"0"

getSitePageModifier

Retrieves the user who last modified a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageModifierQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: User|error

Sample code:

pages:User result = check client->getSitePageModifier("site-id", "page-id-1");

Sample response:

{
  "id": "user-id-2",
  "displayName": "Jane Smith",
  "userPrincipalName": "[email protected]",
  "mail": "[email protected]"
}

getSitePageModifierMailbox

Retrieves the mailbox settings of the user who last modified a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageModifierMailboxQueries`	No	OData query parameters (`$select`, `$expand`)

Returns: MailboxSettings|error

Sample code:

pages:MailboxSettings result = check client->getSitePageModifierMailbox("site-id", "page-id-1");

Sample response:

{
  "timeZone": "Eastern Standard Time",
  "language": {
    "locale": "en-US",
    "displayName": "English (United States)"
  },
  "automaticRepliesSetting": {
    "status": "disabled"
  }
}

updateSitePageModifierMailbox

Updates the mailbox settings property value of the user who last modified a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`payload`	`MailboxSettings`	Yes	New property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

pages:MailboxSettings payload = {timeZone: "UTC"};
check client->updateSitePageModifierMailbox("site-id", "page-id-1", payload);

listSitePageModifierServiceErrors

Retrieves the service provisioning errors for the user who last modified a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*ListSitePageModifierServiceErrorsQueries`	No	OData query parameters (`$orderby`, `$select`, `$expand`)

Returns: ServiceProvisioningErrorCollectionResponse|error

Sample code:

pages:ServiceProvisioningErrorCollectionResponse result = check client->listSitePageModifierServiceErrors("site-id", "page-id-1");

Sample response:

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#...",
  "value": []
}

getSitePageModifierServiceErrorsCount

Gets the total count of service provisioning errors for the user who last modified a SitePage-typed page.

Parameters:

Name	Type	Required	Description
`siteId`	`string`	Yes	The unique identifier of the site
`baseSitePageId`	`string`	Yes	The unique identifier of the baseSitePage
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`*GetSitePageModifierServiceErrorsCountQueries`	No	OData query parameters (`$filter`, `$search`)

Returns: string|error

Sample code:

string result = check client->getSitePageModifierServiceErrorsCount("site-id", "page-id-1");

Sample response:

"0"

Client​

Configuration​

Initializing the client​

Operations​

Page Management​

Site Page Operations​

Canvas Layout​

Horizontal Section Management​

Horizontal Section Column Management​

Horizontal Section Column Web Part Management​

Vertical Section Management​

Vertical Section Web Part Management​

Site Page Web Part Management​

User Metadata (Base Site Page)​

User Metadata (Site Page)​

Client

Configuration

Initializing the client

Operations

Page Management

Site Page Operations

Canvas Layout

Horizontal Section Management

Horizontal Section Column Management

Horizontal Section Column Web Part Management

Vertical Section Management

Vertical Section Web Part Management

Site Page Web Part Management

User Metadata (Base Site Page)

User Metadata (Site Page)