Javascript REST API library for Sharepoint
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc
lib
LICENSE
README.md

README.md

Jello for Sharepoint Lists

Jello is built to consume Sharepoint REST API for list manipulation. I try my best to keep each and every release clean by shipping few but robust features. You are still bound to notice a few issues or limitations. Please use the github issue list to add any issues or features you would like to have in Jello.

Why use Jello?

Jello is designed to make developing on Sharepoint lists using REST API fun. It is attempt to help developers build apps (esp. single page applications) that work with Sharepoint lists focus on business logic.

Top features

  • Automated call for X-RequestDigest
  • Method chaining for list queries
  • Easily page through list query results (paging support)

Getting started

Jello is easy to use. With the first few releases we are focusing on REST API with Sharepoint lists only. Jello has a dependency on jQuery. Make sure you have jQuery loaded in your page before starting to consume Jello.

Initialize on a list

To initialize Jello on a Sharepoint list, you need to provide the siteUrl and listOptions respectively. The returned Jello object can then be used to perform operations on the list.

var TaskList = new Jello("https://contoso.sharepoint/sites/mysubsite",{
    name: "TaskList", // list name
    contentType: "SP.Data.TaskListListItem" // list item content type
});

Get list items Jello.get

accepts

top: optional If top is passed, those number of results will be queried from list. Uses $top.

returns

jQuery promise object.

TaskList.get().then(function (resp) {
    console.log("List results", resp);
}, function (err) {
    console.error("Failed because", err);
});

// Gets 500 items
TaskList.get(500).then(function(items){
	console.log("Items", items);
},
function (err) {
	console.log("Error fetching items", err);
});

Get list item Jello.getById

accepts

ID: If item's ID is provided get will return a single list item.

returns

jQuery promise object.

TaskList.getById(12).then(function(item){
	console.log("Item", item);
},
function (err) {
	console.log("Error fetching item", err);
});

Create list item Jello.add

accepts

item: Object denoting list item to be added

returns

jQuery promise object.

TaskList.add({
    Title: "Get eggs",
    Status: false
}).done(function (resp) {
    console.log("Added", resp);
}).fail(function (err) {
    console.log("Failed because", err);
});

Update list item Jello.update

accepts

ID: List item ID item: Object carrying properties that need to be updated along with their desired values etag: optional Provides a way to verify that the object being changed has not been changed since it was last retrieved. If not provided, item properties will be overwritten.

returns

jQuery promise object.

TaskList.update(12, {
	Title: "Get 8 eggs"
}).then(function(){
	console.log("Successfully updated");
},
function(err) {
	console.log("Err updating", err);
});

Delete list item Jello.remove

accepts

ID: List item ID etag: optional Provides a way to verify that the object being changed has not been changed since it was last retrieved.

returns

jQuery promise object.

TaskList.remove(12).then(function(){
	console.log("Successfully deleted");
},
function(err) {
	console.log("Err deleting", err);
});

Query list items Jello.query

accepts

filter: OData filter string

returns

jQuery promise object.

TaskList.query("$filter=Status eq 1&$top=500").then(function(results){
	console.log("Query results", results);
},
function(err) {
	console.log("Err querying", err);
});

Method chaining

Adopting a developer friendly pattern to make list queries. From Jello 0.3 method chaining is supported.

TaskList.expand('AssignedTo/Title')
	.select("Title,Status,AssignedToId,AssignedTo/Title")
	.where("Status eq 0").get(4)
	.then(function(res){
    console.log("Method chain result", res);
}, function (err) {
    console.log("Error method chain", err);
});

Jello.get executes the constructed query. The top parameter can be passed to specific the number of items desired.

###Supported methods

  • Jello.where appends $filter
  • Jello.select appends $select
  • Jello.orderBy appends $orderby
  • Jello.expand appends $expand

For OData query reference, check https://msdn.microsoft.com/en-us/library/office/fp142385.aspx

Note

This code is available to you as is without any warranties. It can do wonders, or shatter your dreams to pieces. The developers take no liability.