Hard learned CSOM and REST tips
5 likes5,937 views
The document presents insights from a session by Sahil Malik at the SharePoint and Project Conference Adriatics 2013, focusing on hard-learned tips for SharePoint development using CSOM and REST. It covers the differences between synchronous and asynchronous programming, the structure of REST APIs, how to use CSOM, and various CRUD operations with SharePoint lists. Additionally, it highlights challenges related to asynchronous code, error handling, and provides practical examples of REST API queries.
Hard learned CSOM and REST tips
- 1. Hard learned CSOM and REST SAHIL MALIK WWW.WINSMARTS.COM @SAHILMALIK SHAREPOINT AND PROJECT CONFERENCE ADRIATICS 2013 ZAGREB, NOVEMBER 27-28 2013
- 2. sponsors
- 3. C:>whoami 11xMVP 15xAuthor Pluralsight Author Microsoft Metro Trainer Funny and Honest HTTP://BLAH.WINSMARTS.COM @SAHILMALIK
- 4. Hard learned SharePoint dev tips 0945AM Hard learned CSOM and REST 0345PM
- 5. Client side technologies in SharePoint 2013
- 6. Why Microsoft created REST and CSOM?
- 7. Why Microsoft created REST and CSOM
- 8. Why do you need to learn about REST and CSOM? * There are some minor differences in the REST/CSOM API in Office 365
- 9. Synchronous vs. Asynchronous var data = DownloadData(...); ProcessData(data); DownloadDataAsync(... , data => { ProcessData(data); });
- 10. Synchronous vs. Asynchronous var data = DownloadData(...); ProcessData(data); DownloadDataAsync(... , data => { ProcessData(data); });
- 11. Asynch Code challenges – Error Handling DownloadDataAsync(... , data => { ProcessData(data); });
- 12. Asynch Code Challenges – Timing issues
- 13. Asynch Code Challenges - Concurrency
- 15. Concurrency, so how does it work?
- 17. CSOM/REST comparison What CSOM REST Going to the server ExecuteQuery ExecuteQueryAsync $.get $.getJSON $.ajax Concurrency Checks built into framework during save operations. Object Identity & Object Tracking eTAG support Data Objects Objects that inherit from ClientObject JavaScript objects, or similar non-intelligent business objects Usual application Usually C# etc. (server side code in apps) Usually browser side code (usually JavaScript) Security Piggy backs on transport security + OAuth Piggy backs on browser security + OAuth Community support SharePoint specific – some support. JavaScript and jQuery and REST are open standards – lots of support.
- 18. CSOM
- 19. How CSOM works Create a ClientContext Use Load/LoadQuery to specify what data you wish to get Get data using ExecuteQuery/ExecuteQueryAsync Make changes to data Save data using ExecuteQuery/ExecuteQueryAsync
- 20. How CSOM works Client Application Server Sequence of commands: Client.svc command 1; command 2; command 3; context.ExecuteQuery(); Process results XML JSON Execute commands in the batch: command 1; command 2; command 3; Send results back
- 21. ClientContext
- 22. Client Objects Server (Microsoft .SharePoint) .NET Managed (Microsoft.SharePoint .Client) Silverlight (Microsoft.SharePoint .Client.Silverlight) JavaScript (SP.js) SPContext ClientContext ClientContext ClientContext SPSite SPSite SPSite Site SPWeb SPWeb SPWeb Web SPList SPList SPList List SPListItem SPListItem SPListItem ListItem SPField SPField SPField Field SPWeb.Title SPWeb.Title SPWeb.Title web.get_Title(); web.set_Title(); Member names mostly the same from server to client (e. g., SPWeb.QuickLaunchEnabled = SPWeb.QuickLaunchEnabled) JavaScript frequently has get_ set_ methods instead of properties
- 24. Update Data
- 26. Upload file using CSOM
- 27. How to use CSOM? – Silverlight http://blah.winsmarts.com/2010-3-Integrating_Silverlight_BING_Maps_with_SharePoint_2010.aspx
- 28. How to use CSOM? – Windows Phone
- 29. How to use CSOM? – JavaScript
- 30. Referencing CSOM by hand
- 31. Get and Set Web properties
- 32. Get List Items
- 33. Method Chaining
- 34. CRUD Operations
- 35. REST API
- 36. What is REST?
- 38. REST API
- 39. SharePoint 2013 REST URL structure http://server/site/_api/site
- 40. SharePoint REST API Parameter structure http://server/site/_api/web/getAvailableWebTemplates(lcid=1033, includeCrossLanguage=true)
- 41. SharePoint REST service parameter aliasing syntax http://server/site/_api/userProfiles/People(7)/GetWorkplace(@address)?@address={"__metadata":{"type: "ODataDemo.Address"},"Street":"NE 228th", "City":"Sammamish","State":"WA","ZipCode":"98074","Country": "USA"}
- 42. REST service syntax for parameters in query string http://<server>/<site>/_api/web/applyWebTemplate?template=”STS#0”
- 44. REST Query Operators Supported Numeric comparisons •Lt •Le •Gt •Ge •Eq •Ne String comparisons •startsWith •substringof •Eq •Ne Date and time functions •day() •month() •year() •hour() •minute() •second() Not supported •Arithmetic operators (Add, Sub, Mul, Div, Mod) •Basic math functions (round, floor, ceiling) •endsWith •replace •substring •tolower •toupper •trim •concat •DateTimeRangesOverlap operator •Querying as to whether a date time falls inside a recurrent date time pa
- 45. Example
- 46. Example Queries Description URL endpoint HTTP method Body content Retrieves the title of a list web/title GET Not applicable Retrieves all lists on a site lists GET Not applicable Retrieves a single 'list's metadata lists/getbytitle('listname') GET Not applicable Retrieves items within a list lists/getbytitle('listname')/items GET Not applicable Retrieves a specific property of a document. (In this case, the document title.) lists/getbytitle('listname')?select=Ti tle GET Not applicable Creates a list lists POST { '_metadata':{'type':SP.List}, 'AllowContentTypes': true, 'BaseTemplate': 104, 'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'RestTest' } Adds an item to a list lists/getbytitle('listname')/items POST { '_metadata':{'type':SP. listnameListItem}, 'Title': 'MyItem' }
- 47. HTTP Methods
- 48. HTTP Methods
- 49. Form Digest
- 50. /contextinfo Property Description webFullUrl Gets the server-relative URL of the nearest site. siteFullUrl Gets the server-relative URL of the root of the site collection that the site is contained within. If the nearest web is the root of a site collection, then the value of the webFullUrl property is equal to the siteFullUrl property. formDigestValue Gets the server's request form digest. LibraryVersion Gets the current version of the REST library. SupportedSchemaVersions Gets the versions of the schema of the REST/CSOM library that are supported.
- 52. CRUD Operations
- 53. Create a site
- 54. Create a list
- 55. Create a file in a doc lib Create a file in a folder
- 56. Update – Either PUT or PATCH(MERGE)
- 57. Update using PUT
- 59. Getting contents of a file
- 60. Deletes
- 61. ETags
- 62. Get Changes since last refresh
- 65. thank you. SHAREPOINT AND PROJECT CONFERENCE ADRIATICS 2013 ZAGREB, NOVEMBER 27-28 2013