SharePoint2013Odata常用实例基本操作

迷南。 2022-04-10 03:19 172阅读 0赞

SharePoint 2013 的Odata service的常用URI实例：

<table> 
 <tbody> 
  <tr> 
   <td>URI实例</td> 
   <td>解释</td> 
  </tr> 
  <tr> 
   <td><span style="color:#333333;">_api/web/title</span></td> 
   <td>返回web title&nbsp;</td> 
  </tr> 
  <tr> 
   <td>_api/web/lists(guid'&lt;list id&gt;')</td> 
   <td>返回列表</td> 
  </tr> 
  <tr> 
   <td>_api/web/lists/getByTitle('Announcements')/fields</td> 
   <td>返回列表的所有字段</td> 
  </tr> 
  <tr> 
   <td>_api/web/lists/getByTitle('Task')/items</td> 
   <td>返回Tas列表的所有item</td> 
  </tr> 
  <tr> 
   <td>_api/web/siteusers</td> 
   <td>返回该站点所有用户</td> 
  </tr> 
  <tr> 
   <td>_api/web/sitegroups</td> 
   <td>返回该站点所有用户组</td> 
  </tr> 
  <tr> 
   <td>_api/web/sitegroups(3)/users</td> 
   <td>返回该站点所有在id为3的用户组的用户</td> 
  </tr> 
  <tr> 
   <td>_api/web/GetFolderByServerRelativeUrl('/Shared Documents')</td> 
   <td>返回Shared Documents文档库根目录</td> 
  </tr> 
  <tr> 
   <td>_api/web/GetFolderByServerRelativeUrl('/Plans')/Files('a.txt')/$value</td> 
   <td>返回Plans文档库根目录下的a.txt文件</td> 
  </tr> 
 </tbody> 
</table>

带Query option的实例：

<table style="width:616.66px;"> 
 <tbody> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:bottom;">查询选项</td> 
   <td style="border-color:#c0c0c0;vertical-align:bottom;">作用</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$select</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">指定返回字段（列）</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$filter</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">指定过滤条件</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$expand</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">用于关联列表，指定返回关联字段(列)</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$top</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">指定返回前N条记录</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$skip</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">指定返回结果跳过前N行记录</td> 
  </tr> 
  <tr> 
   <td style="border-color:#c0c0c0;vertical-align:top;">$orderby</td> 
   <td style="border-color:#c0c0c0;vertical-align:top;">指定按某个字段排序</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td>URI实例</td> 
   <td>解释</td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle(
&nbsp; 'Books')/items?$select=Title,PublishedBy/Name&amp;$expand=PublishedBy</code></pre> </td> 
   <td>前提book里面有个 <pre><code>PublishedBy 的字段关联到Publisher 列表</code></pre> <pre><code>
</code></pre> <pre><code>返回Books列表的Title和关联</code></pre> <pre><code>Publisher 列表项目的Name</code></pre> </td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle('Books')/items?$top=10&amp;$skip=2</code></pre> </td> 
   <td>返回Books列表的3~10项纪录</td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle('Books')/items?$skip=2&amp;$top=10</code></pre> </td> 
   <td>返回Books列表的3~12项纪录</td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle('Books')/items?$orderby=ID desc&amp;$top=2</code></pre> </td> 
   <td>返回Books列表的最后两条记录</td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle(
&nbsp; 'Books')/items?$select=Title&amp;$filter=Author eq 'Mark Twain'&amp;$top=2</code></pre> </td> 
   <td>返回<span style="color:#333333;"><span style="color:#333333;">Author 等于</span></span> <pre><code> 'Mark Twain'的头两条记录</code></pre> </td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle('Books')/items?$orderby=Title asc</code></pre> </td> 
   <td>返回Books列表的所有记录并按Title升序排列</td> 
  </tr> 
  <tr> 
   <td> <pre><code>_api/web/lists/getByTitle('Books')/items?$select=Author,Title,ISBN</code></pre> </td> 
   <td>返回Books列表下记录（只返回列 <pre><code>Author,Title,ISBN</code>）</pre> </td> 
  </tr> 
 </tbody> 
</table>

使用JQuery + Odata实现增删改查

按Json格式查询：

**\[javascript\]** [view plain][][copy][view plain][print][view plain][?][view plain]

1.  function onGetCustomer(customerId) \{  
2.     
3.    // begin work to call across network  
4.    var requestUri = \_spPageContextInfo.webAbsoluteUrl +  
5.                  "/\_api/Web/Lists/getByTitle('Customers')/items(" + customerId + ")";  
6.     
7.    // execute AJAX request  
8.    $.ajax(\{  
9.      url: requestUri,  
10.     type: "GET",  
11.     headers: \{ "ACCEPT": "application/json;odata=verbose" \},  
12.     success: function(data)\{  
13.       alert(data.d.FirstName);  
14.     \},  
15.     error:  function()\{  
16.       alert("Failed to get customer");  
17.     \}  
18.   \});  
19. \}

添加：

**\[javascript\]** [view plain][][copy][view plain][print][view plain][?][view plain]

1.  function onAddCustomer() \{  
2.    
3.      var requestUri = \_spPageContextInfo.webAbsoluteUrl +  
4.                "/\_api/Web/Lists/getByTitle('Customers')/items/";  
5.    
6.      var requestHeaders = \{  
7.        "ACCEPT": "application/json;odata=verbose",  
8.        "X-RequestDigest": $("\#\_\_REQUESTDIGEST").val(),  
9.      \}  
10.   
11.     var customerData = \{  
12.       \_\_metadata: \{ "type": "SP.Data.CustomersListItem" \},  
13.       FirstName: "Paul"  
14.     \};  
15.   
16.     requestBody = JSON.stringify(customerData);  
17.   
18.     $.ajax(\{  
19.       url: requestUri,  
20.       type: "Post",  
21.       contentType: "application/json;odata=verbose",  
22.       headers: requestHeaders,  
23.       data: requestBody,  
24.       success: function()\{  
25.         alert("Created customer");  
26.       \},  
27.       error: function()\{  
28.         alert("Failed to create customer");  
29.       \}  
30.     \});  
31.   \}  
32. \}

删除：

**\[javascript\]** [view plain][][copy][view plain][print][view plain][?][view plain]

1.  function onDeleteCustomer(customerId) \{  
2.    
3.    var requestUri = \_spPageContextInfo.webAbsoluteUrl +  
4.                  "/\_api/Web/Lists/getByTitle('Customers')/items(" + customerId + ")";  
5.    
6.    var requestHeaders = \{  
7.      "ACCEPT": "application/json;odata=verbose",  
8.      "X-RequestDigest": $("\#\_\_REQUESTDIGEST").val(),  
9.      "If-Match": "\*" // delete the item even if another user has updated it since we last fetched it  
10.   \}  
11.   
12.   $.ajax(\{  
13.     url: requestUri,  
14.     type: "DELETE",  
15.     contentType: "application/json;odata=verbose",  
16.     headers: requestHeaders,  
17.     success: function()\{  
18.       alert("Deleted customer");  
19.     \},  
20.     error: function()\{  
21.       alert("Failed to delete customer");  
22.     \}  
23.   \});  
24.   
25. \}

修改：

**\[javascript\]** [view plain][][copy][view plain][print][view plain][?][view plain]

1.  function onUpdateCustomer(customerId, firstName) \{  
2.    // first we need to fetch the eTag to ensure we have the most recent value for it  
3.    var requestUri = \_spPageContextInfo.webAbsoluteUrl +  
4.                  "/\_api/Web/Lists/getByTitle('Customers')/items(" + customerId + ")";  
5.     
6.    // execute AJAX request  
7.    $.ajax(\{  
8.      url: requestUri,  
9.      type: "GET",  
10.     headers: \{ "ACCEPT": "application/json;odata=verbose" \},  
11.     success: function(data)\{  
12.       // got the eTag  
13.       var etag = data.d.etag;  
14.     
15.       var requestUri = \_spPageContextInfo.webAbsoluteUrl +  
16.                 "/\_api/Web/Lists/getByTitle('Customers')/items(" + customerId + ")";  
17.         
18.       // set the MERGE verb so we only need to provide the update delta  
19.       var requestHeaders = \{  
20.         "ACCEPT": "application/json;odata=verbose",  
21.         "X-RequestDigest": $("\#\_\_REQUESTDIGEST").val(),  
22.         "X-HTTP-Method": "MERGE",  
23.         "If-Match": etag  
24.       \}  
25.     
26.       var customerData = \{  
27.         \_\_metadata: \{ "type": "SP.Data.CustomersListItem" \},  
28.         FirstName: firstName  
29.       \};  
30.     
31.       requestBody = JSON.stringify(customerData);  
32.     
33.       $.ajax(\{  
34.         url: requestUri,  
35.         type: "POST",  
36.         contentType: "application/json;odata=verbose",  
37.         headers: requestHeaders,  
38.         data: requestBody,  
39.         success: function(data)\{  
40.           alert("Updated customer");  
41.         \},  
42.         error: function(data)\{  
43.           alert("Failed to update customer");  
44.         \}  
45.       \});  
46.     \},  
47.     error:  function(data)\{  
48.       alert("Failed to get customer eTag");  
49.     \}  
50.   \});  
51. \}

[view plain]: http://blog.csdn.net/abrahamcheng/article/details/12612455