SP.ListTemplate object

  • Article

Specifies a list template.

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

var object = new SP.ListTemplate()

Members

The ListTemplate object has the following members.

Constructor

The ListTemplate object has the following constructor.

Constructor

Description

ListTemplate

Initializes a new instance of the SP.ListTemplate object.

Methods

The ListTemplate object has the following methods.

Method

Description

initPropertiesFromJson

Properties

The ListTemplate object has the following properties.

Property

Description

allowsFolderCreation

Gets a value that specifies whether new list folders can be added to a list created from the list template.

baseType

Gets a value that specifies the base type of the list template.

description

Gets a value that specifies the description of the list template.

featureId

Gets a value that specifies the feature identifier of the feature that contains the list schema for the list template.

hidden

Gets a value that specifies whether the list template is hidden from the user interface for creating new lists.

imageUrl

Gets a value that specifies the URL for the icon of the list template.

internalName

Gets a value that specifies the identifier for the list template.

isCustomTemplate

Specifies whether the list template is user created.

listTemplateTypeKind

Gets a value that specifies the list server template.

name

Gets a value that specifies the display name of the list template.

onQuickLaunch

Gets a value that specifies whether the list template can be used to create only one list in a site collection, and that the list template is hidden from the user interface for creating new lists.

unique

Gets a value that specifies whether the list template can be used to create only one list in a site collection, and that the list template is hidden from the user interface for creating new lists.

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/ListTemplates(templatename)

HTTP requests

This resource supports the following HTTP commands:

POST syntax

POST http://<sitecollection>/<site>/_api/web/ListTemplates(templatename)