SP.Site.runUpgradeSiteSession Method (sp.js)

  • Article

Either runs a site collection upgrade, or schedules it to be run in the future, depending on available system resources and the value of the queueOnly parameter.The user executing this method MUST be a farm administrator or a site collection administrator.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.Site.runUpgradeSiteSession()

Parameters

  • versionUpgrade
    If true, specifies that a version-to-version upgrade will be performed. If false, specifies that a build-to-build upgrade will be performed.

  • queueOnly
    If true, specifies that the upgrade will not be run immediately; it will be queued for a later run.

  • sendEmail
    If true, a notification email will be sent to the requestor and the site collection administrators at the completion of the site collection upgrade. If false, such notification will not be sent.

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/site/runUpgradeSiteSession(versionUpgrade,queueOnly,sendEmail)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/site/runUpgradeSiteSession(versionUpgrade,queueOnly,sendEmail)

Resource parameters

  • versionUpgrade

  • queueOnly

  • sendEmail