SpRestLib API Demos

Setup
List/Library
File
Folder
Site
User
REST API
Sandbox

Welcome!

Check your setup below to ensure SpRestLib is configured correctly
If everything looks okay, then all the functionality in the demo tabs are ready to explore.
Please check the GitHub Project Site for setup and configuration FAQs and full documentation.

JavaScript Library Check

SpRestLib

jQuery

TableSorter

SpRestLib Base URL

List/Library Methods

See API documentation for examples of items(), create(), update(), delete(), and recycle() methods
Select one of the Lists/Libraries found on this site to view its properties (only non-hidden Lists/Libraries are shown)

Select List/Library

List Information

sprLib.list('listName').info()

List Columns

sprLib.list('listName').cols()

List Permissions

sprLib.list('listName').perms()

Name	Type	Permissions

File Methods

Select one of the Files found on this site to view File method code/results.

Select Library

Select Library File

File Info: (Permissions, Properties, Versions)

File Properties

sprLib.file('fileName').info()

File Properties by Version

sprLib.file('fileName').info({ version:1 })

File Permissions

sprLib.file('fileName').perms()

Name	Type	Permissions

File Manipulation: (Delete/Recycle, Download)

Download File

Saving a SharePoint file (text or binary) using client web browser.
The `sprLib` Promise returns a blob which can be saved easily - without FileSaver or other libraries.

sprLib.file('fileName').get()

Delete File (PERMANENT - bypasses Recycle Bin)

sprLib.file('fileName').delete()

Recycle File (sends item to the site Recycle Bin)

sprLib.file('fileName').recycle()

Folder Methods

Select a site library/folder to autopopulate the code samples/results below.

Select Library

Select Library Folder

Folder Info: (Permissions, Properties)

Folder Properties

sprLib.folder('folderName').info()

Folder Permissions

sprLib.folder('folderName').perms()

Name	Type	Permissions

Folder Contents: (Files, Folders)

Folder Contents: Files

sprLib.folder('folderName').files()

Folder Contents: Folders

sprLib.folder('folderName').folders()

Folder Manipulation: (Add, Delete, Recycle)

Add Folder

sprLib.folder('FolderName').add('NewFolder')

New Folder Name

Please enter a new folder name

Delete Folder (PERMANENT - bypasses Recycle Bin)

sprLib.folder('FolderName').delete()

Recycle Folder (sends item to the site Recycle Bin)

sprLib.folder('FolderName').recycle()

Local Site Methods

These methods are scoped to the local site and will return results for this particular site (eg: a subsite)

Site Contents

sprLib.site().lists()

List Name/Desc	Type	Items

Site Info

sprLib.site().info()

Prop Name	Prop Value

Site Permissions

sprLib.site().perms()

Member	Roles/Levels

Site Subsites

sprLib.site().subsites()

Name	Created	Modified	Relative URL	Site Logo URL

Site Collection Methods

These methods are scoped to the top level site - the Site Collection, not subsites - meaning, you'll get the same results whether you include a subsite

Site Permission Groups

sprLib.site().groups()

Title	Owner	Members	Description	Member Names

Site Permission Roles/Levels

sprLib.site().roles()

Name	Description

Site Users

sprLib.site().users()

Title	LoginName	Email	IsSiteAdmin	Groups	Group Details

User Methods

Get User Information (Title, Email, etc.) and User Groups (which SP Groups they belong to)

User Information

User Groups

User Profile Methods

The user().profile() method utliizes the UserProfile Service API, which requires either an enterprise license for on-prem installations, or a SharePoint Online subscription.

Individual User Profile Properties

All User Profile Properties

REST API

SpRestLib also provides the ability to run an ad-hoc REST query.

Sample Query

Query Results

Code Sandbox

The code below is editable - use it try any sprLib features.
The sandbox will handle the then() and catch() for you, so just use code as shown see below.
Both array results (ex:`list().items()`) and object results (ex:`list().info()`) are supported.