Introduction to the SharePoint 2013 REST API By QuontraSolutions Email : info@quontraolution!com "all u : #0#$%00$%%&& 'e(Site : )))!quontraolution!com
Oct 07, 2015
PowerShell Fundamentals for SharePoint 2010/2013
Introduction to the SharePoint 2013 REST API By QuontraSolutionsEmail: [email protected] us: 404-900-9988WebSite: www.quontrasolutions.comAGENDAREST and ODATA OverviewSharePoint 2013 REST APIDemos2SLIDE 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.
2REST IntroductionREST = REpresentational State TransferA simpler alternative to SOAP based on HTTP request/response pairsClient sends HTTP requests that target specific resources using unique URIs3SLIDE 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.
3What is OData?Odata is a standardized REST API for Data AccessODATA API maps CRUD operations to HTTP verbshttp://www.odata.org
4SLIDE 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.
4HTTP MethodsGETReturns an item or array of itemsPOSTCreates a new itemPUTUpdates an item (replaces all fields with default values)PATCH or MERGEUpdates an item in place (existing values are retained)DELETEDeletes an item5Patch Odata V3Merge 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.
5OData URIsURI has three partsService root URIResource pathQuery string options
6
Service Root URIResource Path to a SharePoint ObjectQuery String OptionsSLIDE 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.
6OData Query Option Parameters$selectSpecifies which columns to retrieve$filterSelecting what items to retrieve$orderbySorting items$expandRetrieve results that are usually deferred$topSelect how many items to return$skipSelecting which row to start at
7SLIDE 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.
7DEMO 8SLIDE 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.
8Critical ToolsFiddlerCore jQuery libraryBrowser developer toolsAdvanced REST Client (Chrome App)Postman (Chrome App)9SLIDE 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.
9Request HeadersAcceptwhat type of data you want to receiveContent-typeWhat type of data you are sending in the request bodyX-HTTP-MethodWhich operation to performX-Request DigestEncrypted security value required for updatesIF-MATCHPasses Etag value to control optimistic concurrency
10SLIDE 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.
10AJAX Calls$.ajax() function is part of the core jQuery libraryURI end pointAccept header: application/json;odata=verbose
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.
11Request DigestProvides security mechanism to protect against replay attacksSharePoint pages has element with ID __REQUESTDIGESTPassed in request by using X-RequestDigest header/_api/contextinfo
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.
12Creating / Updating You must include item type metadata for inserts & updatesAll write operations must pass valid request digest value
13SLIDE 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.
13List Item Type MetadataEach SharePoint list has a unique type for its list items
String based type value must be passed will all inserts and updates14
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.
14Creating list items15
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.
15Delete list items16
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.
16Update List Items17
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.
17Current REST IssuesREST API does have support for Managed MetadataWorkflowsLacks batching support *
18SLIDE 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.
18Thank You!19