Multiple lines of text :: Enhanced RichtextĬolumn is required in the $expand keywordĬolumn is required in the $expand keyword, append “Id” to the column name to get the user id (UserInformationList) value inline with each entryĬolumn is required in the $expand keyword, append “Id” to the column name to get the lookup column target id value inline with each entry Further, not all types of column will return data for an entry just by including them in the $select parameter, an example of which is Lookup (single or multi-value) columns. Not all types of column are available via REST, most annoyingly managed metadata columns are amongst this group of unsupported column types. Using the example above, each list entry returned will include values for the ID, Title and My Document Type columns. Use the $select query string parameter to restrict the returned entry columns, the value of this parameter is a comma separated list of column names as specified above. An exception is the ID column, you must refer to this column as Id – for some reason. When specifying a column name you should also ensure that it does not include any spaces, so if your column has a display name of “My Column Name”, the column name you include in the REST URL would be “M圜olumnName”. Unlike JSOM or SPServices, the REST interface requires that you use column Display Names rather than internal names. So far the examples have not specified which list columns should be returned with each list entry, by default the SharePoint REST API returns all list entry properties (columns) either when there is no $select query option or when the query option is set to *. Using the $select Query Option to Restrict Returned Columns.

Retrieve a list item by it’s ID and return a single property value Retrieve a list item by it’s ID and return a single property Return all list items from a list called “REST Test Data” Moving on we will continue by example, showing some typical types of request and the responses. List titles in REST are case sensitive and should not include any spaces, so if your list/library is titled “My List Stuff”, the list title you would add to the URL would be “MyListStuff”. To work with lists and libraries using REST, you append the list or library display title to the base url.

This entity-set schema XML is actually a Microsoft Entity Framework EDMX file and you return it by appending the $metadata keyword after the base url as shown below Working with Lists and Libraries using REST. The REST API will return a complete schema describing the entity-set collection at the service URI, this is a complex piece of XML (it cannot be returned as a JSON object tree, although the AIR tool does convert it to an object tree in the UI) which decribes the entity-set collection, its types, relationships and a whole lot more. If you execute a request using the base url above, you will get back a list of the entity sets found at the service URI Entity-set Schema. So, to begin, the base url for all REST calls is made up as follows Along with XML, SharePoint REST will also return data in JSON format, which I think will most interest developers, particularly those using the jQuery $.getJSON() function. For simple queries this works well, but as you begin to use REST for more complex solutions this quickly becomes annoying because the URL’s start to get quite long. OData: Javascript Object Notation (JSON) Format.īy default the REST API returns data in XML format, which means that you can just enter REST queries into the browser window and see the results.Programming using the SharePoint 2013 REST Service.In SharePoint 2013, the REST interface has been hugely expanded and emulates much of the functionality available using the Javascript Client API (JSOM), but everything in this post is still relevant in 2013, since listdata.svc still exists. REST is one of the client access API’s first introduced in SharePoint 2010. Paging Data and the $top, $orderby, $skip and $inlinecount Parameters.Using the $orderby Query Option to Sort Data.Using the $filter Query Option to Filter Data.Retrieving list item Choice column values.

Retrieving list item Lookup or User (Person/Group) column values.Using the $select Query Option to Restrict Returned Columns.Client and Server Driven Paging with the SharePoint REST API.SharePoint: Adventures with the REST API Part 2 – The AIR Tool.SharePoint: Adventures with the REST API Part 1.

Svc filter designer