SP.File.checkOutType property (sp.js)

Gets a value that indicates how the file is checked out of a document library.

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

var value = SP.File.get_checkOutType ()

Return value

Type: SP.CheckOutType

One of the enumeration values that specifies the type of checkout.


The checkout state of a file is independent of its locked state.

REST resource endpoint

See File resource for more information.

Endpoint URI structure


HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)/checkOutType

GET syntax

GET http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)/checkOutType