Introduction to SharePoint 2013 REST API
2 likes588 views
The document introduces the SharePoint 2013 REST API and REST/OData concepts. It discusses retrieving and modifying SharePoint data through HTTP requests to the REST API, using URIs, query parameters, and request headers. Examples are provided for GET, POST, PUT, and DELETE operations on SharePoint list items.
![[SharePoint Korea Conference 2013 / 강율구] Sharepoint 스마트하게 개발하기](https://cdn.slidesharecdn.com/ss_thumbnails/sharepointconferencesmartv1-130724092345-phpapp01-thumbnail.jpg?width=560&fit=bounds)
Ad
More Related Content
What's hot (20)
Similar to Introduction to SharePoint 2013 REST API (20)
Ad
More from QUONTRASOLUTIONS (20)
Ad
Recently uploaded (20)
Introduction to SharePoint 2013 REST API
- 1. Introduction to the SharePoint 2013 REST API By QuontraSolutions Email : [email protected] Call us : 404-900-9988 WebSite : www.quontrasolutions.com
- 2. AGENDA ◦ REST and ODATA Overview ◦ SharePoint 2013 REST API ◦ Demos 2
- 3. REST Introduction ◦ REST = REpresentational State Transfer ◦ A simpler alternative to SOAP based on HTTP request/response pairs ◦ Client sends HTTP requests that target specific resources using unique URIs 3
- 4. What is OData? ◦ Odata is a standardized REST API for Data Access ◦ ODATA API maps CRUD operations to HTTP verbs ◦ http://www.odata.org 4
- 5. HTTP Methods ◦ GET Returns an item or array of items ◦ POST Creates a new item ◦ PUT Updates an item (replaces all fields with default values) ◦ PATCH or MERGE Updates an item in place (existing values are retained) ◦ DELETE Deletes an item 5
- 6. OData URIs ◦ URI has three parts Service root URI Resource path Query string options 6 Service Root URI Resource Path to a SharePoint Object Query String Options
- 7. OData Query Option Parameters ◦ $select Specifies which columns to retrieve ◦ $filter Selecting what items to retrieve ◦ $orderby Sorting items ◦ $expand Retrieve results that are usually deferred ◦ $top Select how many items to return ◦ $skip Selecting which row to start at 7
- 8. DEMO 8
- 9. Critical Tools ◦ Fiddler ◦ Core jQuery library ◦ Browser developer tools ◦ Advanced REST Client (Chrome App) ◦ Postman (Chrome App) 9
- 10. Request Headers ◦ Accept what type of data you want to receive ◦ Content-type What type of data you are sending in the request body ◦ X-HTTP-Method Which operation to perform ◦ X-Request Digest Encrypted security value required for updates ◦ IF-MATCH Passes Etag value to control optimistic concurrency 10
- 11. AJAX Calls ◦ $.ajax() function is part of the core jQuery library ◦ URI end point ◦ Accept header: application/json;odata=verbose 11
- 12. Request Digest ◦ Provides security mechanism to protect against replay attacks ◦ SharePoint pages has element with ID __REQUESTDIGEST ◦ Passed in request by using X-RequestDigest header ◦ <site url>/_api/contextinfo 12
- 13. Creating / Updating ◦ You must include item type metadata for inserts & updates ◦ All write operations must pass valid request digest value 13
- 14. List Item Type Metadata ◦ Each SharePoint list has a unique type for its list items ◦ String based type value must be passed will all inserts and updates 14
- 15. Creating list items 15
- 16. Delete list items 16
- 17. Update List Items 17
- 18. Current REST Issues ◦ REST API does have support for Managed Metadata Workflows ◦ Lacks batching support * 18
- 19. Thank You! 19
Editor's Notes
- #3: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #4: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #5: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #6: Patch Odata V3 Merge Odata V2 SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #7: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #8: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #9: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #10: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #11: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #12: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #13: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #14: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #15: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #16: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #17: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #18: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.
- #19: SLIDE PURPOSE: This is where everything starts – us defining with our customers how we can make an impact in their business regardless of the technology! SPIEL: Technology should be transformative, not a to-do list. Because, really, just about any firm can change the way your IT works. Our mission is for IT to change the way your business works. The difference is a game-changer.