SP.Site.needsUpgradeByType Method (sp.js)

  • Article

true if the object needs to be upgraded; otherwise, false.

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

SP.Site.needsUpgradeByType()

Parameters

  • versionUpgrade
    If true, version-to-version site collection upgrade is requested; otherwise false for build-to-build site collection upgrade.

  • recursive
    If true, child upgradable objects will be inspected; otherwise false.

Return value

Returns true if this site collection requires site collection upgrade of the specified type; otherwise, false.

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/site/needsUpgradeByType(versionUpgrade,recursive)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/site/needsUpgradeByType(versionUpgrade,recursive)