SP.Field.description property (sp.js)

  • Article

Gets or sets a value that specifies the description of the field.

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

var value = SP.Field.get_description ()

var value = SP.Field.set_description ()

Return value

Type: String

A string that contains the description.

REST resource endpoint

See Field resource for more information.

Endpoint URI structure

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

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

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

GET syntax

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