Web

Configure a SharePoint web.


Access

Access the Web API directly from the engineer migration API object. The root web (site collection) can be accessed using engineer.web, and any sub-webs can be accessed using engineer.getWeb(url).

Examples

up(engineer) {
// Update root web
engineer.web.update({
Description: 'New web description',
});

// Update child web/subsite
engineer.getWeb('/my-sub-web').update({
Description: 'New subsite description',
});
}

Properties

contentTypes

Provides access to the ContentTypes API.

fields

Provides access to the Fields API.

lists

Provides access to the Lists API.

webs

Provides access to the Webs API.


Methods

update(options)

Update the web.

Parameters

options
Updated web configuration (Object, required)

Properties of options

See Microsoft’s Web resource documentation for a listing of all possible properties that can be passed to the REST API.

Examples

up(engineer) {
// Update root web
engineer.web.update({
Description: 'New web description',
});

// Update child web/subsite
engineer.getWeb('/my-sub-web').update({
Description: 'New subsite description',
});
}

delete()

Delete the web.

Examples

down(engineer) {
// Delete web
engineer.getWeb('/my-web').delete();
}