Share via

SP.Field.typeShortDescription property (sp.js)

  • Article

Gets a value that specifies the description for the type of the field.

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

var value = SP.Field.get_typeShortDescription ()

Return value

Type: String

A string that contains the field description.

Remarks

It must not be null. It must not be empty.

REST resource endpoint

See Field resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/lists(listid)/fields(fieldid)/typeShortDescription

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/lists(listid)/fields(fieldid)/typeShortDescription

GET syntax

GET http://<sitecollection>/<site>/_api/web/lists(listid)/fields(fieldid)/typeShortDescription