SP.WebTemplate object

  • Article

Specifies a site definition or a site template that is used to instantiate a site.

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

var object = new SP.WebTemplate()

Members

The WebTemplate object has the following members.

Constructor

The WebTemplate object has the following constructor.

Constructor

Description

WebTemplate

Initializes a new instance of the SP.WebTemplate object.

Properties

The WebTemplate object has the following properties.

Property

Description

description

Gets a value that specifies the description for the site definition configuration or site template.

displayCategory

Gets a value that specifies the display name for the category that this site definition configuration or site template is a part of.

id

Gets a value that specifies the unique identifier for the site definition configuration or the site template.

imageUrl

Gets a value that specifies the URI for the image that is associated with the site definition configuration or site template.

isHidden

Gets a value that specifies whether the site definition configuration is displayed in the user interface for creating new sites.

isRootWebOnly

Gets a value that specifies whether the site definition configuration or site template can only be applied to the top-level site in the site collection.

isSubWebOnly

Gets a value that specifies whether the site definition configuration or site template can only be applied to subsites created within the site collection.

lcid

Gets a value that specifies the LCID for the site definition configuration or site template.

name

Gets a value that specifies the name for the site definition configuration or site template.

title

Gets a value that specifies the display name for the site definition configuration or site template.

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguageincludecrosslanguage})/getbyname(templatename

HTTP requests

This resource supports the following HTTP commands:

POST syntax

POST http://<sitecollection>/<site>/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguageincludecrosslanguage})/getbyname(templatename