开发者社区> ghost丶桃子> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

[sharepoint]Rest api相关知识(转)

简介:
+关注继续查看

写在前面

最近又开始弄rest api了,通过sharepoint rest api获取站点信息,Items,fields非常方便,再结合OData查询,更是得心应手。这里记录学习的时候用到的知识点,以及查询的资料。

Sharepoint Rest 端点URI结构

在可以使用 REST 服务访问 SharePoint 资源之前,首先必须知道指向该资源的 URI 端点。只要可能,这些 REST 端点的 URI 就会准确地模仿 SharePoint 客户端对象模型中资源的 API 签名。例如:

客户端对象模型方法:            

List.GetByTitle(listname).GetItems()

REST 端点:            

http://server/site/_api/lists/getbytitle('listname')/items            

但是,在某些情况下,为了遵守 REST 或 OData 约定,端点 URI 会不同于相应的客户端对象模型签名。

下图显示 SharePoint REST URI 的通用语法结构。

SharePoint REST URI 语法结构

SharePoint 资源的部分端点偏离了这种语法结构:

    • 需要复杂类型作为参数的方法。

      如果对应的客户端对象模型方法要求复杂类型作为参数传递,则 REST 端点可能偏离此语法构造说明 REST 限制。

    • 静态方法和属性。

      REST 端点偏离代表静态方法和属性的 URI 的语法结构。

确定 SharePoint 2013 REST 服务端点

若要为 SharePoint 资源构造 REST 端点,请按照以下步骤执行操作:

  1. 从 REST 服务引用开始:

    http://server/site/_api                

  2. 指定合适的入口点。例如:

    http://server/site/_api/web                

  3. 从入口点导航到您要访问的特定资源。这包括为与客户端对象模型中的方法对应的端点指定参数。例如:

    http://server/site/_api/web/lists/getbytitle('listname')                

引用端点 URI 中的 SharePoint 2013 REST 服务

使用 _api 来表示端点 URI 中的 SharePoint 2013 REST 服务。REST 服务属于 client.svc Web 服务的一部分。但是,要尽早构造 REST URI 以及缩短基础 REST URI 路径,REST 服务使用 _api 将显式引用 client.svc Web 服务的需求抽象出来。REST 服务将承认并接受引用 client.svc Web 服务的 URI。例如,您可以使用 http://server/site/_vti_bin/client.svc/web/lists 来代替http://server/site/_api/web/lists。但是,使用 _api 是首选惯例。URL 限制为 256 个字符,因此,使用 _api 可以缩短基础 URI,以留下更多的字符用于构造剩余 URL。

指定 SharePoint 2013 REST 服务的入口点

REST 服务的主要入口点表示网站集合以及指定上下文的网站。这样,这些入口点与客户端对象模型中的 ClientContext.Site 属性和 ClientContext.Web 属性对应。

要访问特定的网站集合,请使用以下构造:

http://server/site/_api/site              

要访问特定的网站,请使用以下构造:

http://server/site/_api/web              

其中 server 表示服务器的名称,site 表示特定网站的名称或路径。

除 /site 和 /web 外,REST 服务包括几个其他访问点,通过这些访问点,开发人员可导航至特定功能。下表列出了部分访问点。

功能区域

访问点

网站

http://server/site/_api/site

Web

http://server/site/_api/web

用户配置文件

http:// server/site/_api/SP.UserProfiles.PeopleManager

搜索

http:// server/site/_api/search

发布

http:// server/site/_api/publishing

导航到您要访问的特定资源

从这里,通过遍历对象模型并使用用斜杠分隔的客户端对象模型中 API 的名称构造多个特定 REST 端点。下表显示客户端对象模型调用及等效 REST 端点示例。

客户端对象模型 API

REST 端点

ClientContext.Web.Lists

http://server/site/_api/web/lists

ClientContext.Web.Lists[guid]

http://server/site/_api/web/lists(‘guid’)

ClientContext.Web.Lists.GetByTitle("Title")

http://server/site/_api/web/lists/getbytitle(‘Title’)

终结点 URI 不区分大小写。例如,在上表中,使用 /getbytitle 指定 GetByTitle() 方法的 REST 等效项。

 指定 REST 端点 URI 中的参数

SharePoint 2013 扩展了 OData 规范,允许您使用括号来指定方法参数和索引值。这可防止包含多个名称相同参数的 URI 中的潜在混淆问题。例如,下面两个 URI 包含名称相同的参数:

http://server/site/_api/web/lists/getByTitle('Announcements')/fields/getByTitle('Description')            

http://server/site/_api/web/lists('<guid>')/fields/getById('<guid>')            

要指定多个参数,请将参数作为名称/值对包含在内,并用逗号将参数分隔。例如:

http://server/site/_api/web/getAvailableWebTemplates(lcid=1033, includeCrossLanguage=true)            

下图显示了 SharePoint REST 参数语法。

SharePoint REST 参数语法

些方法要求大的有效载荷作为参数。对于要与其对应客户端对象模型 API 保持功能平衡的 REST 端点,这些端点必须接受复杂类型作为参数。在这种情况下,REST 服务扩展了现有 OData 协议,允许这些 REST 端点接受单个复杂类型作为参数。这仅适用于 POST 操作,并且您必须根据 OData 标准以 Atom 格式或 JSON 格式传递复杂类型。

例如,ListCollection.Add 方法以 Microsoft.SharePoint.Client.ListCreationInformation 对象作为参数。要将列表添加到指定网站,请按如下方式构造相应的 REST 端点:

http://server/site/_api/web/lists/add              

然后,在请求正文中传递复杂类型,此处使用 JSON 进行格式设置。

复制代码
{ "d" : {
   "results": {
     "__metadata": {
       "type": "SP.ListCreationInformation"
     }, 
     "CustomSchemaXml": "…large payload…/", 
     "Description": "desc", 
     "DocumentTemplateType": "1", 
     "TemplateType": "101", 
     "Title": "Announcements"
   }
} 
}
复制代码

在 REST 服务调用中使用参数别名

您可以在 OData 中使用"参数别名"语义将参数传递到 SharePoint REST 端点。在参数别名中,用参数调用中的别名标识参数值,而实际值则在 URI 的查询字符串中指定。这允许您通过使用查询字符串支持多种类型的字符和一致的格式。

例如,以下两个 REST URI 为等效项:

直接指定参数值:              

http://server/site/_api/web/applyWebTemplate("STS#0")              

使用参数别名,并在 URI 的查询字符串中指定实际参数值:              

http://server/site/_api/web/applyWebTemplate(title=@template)?@template="STS#0"              

但是,SharePoint REST 服务不支持通过参数别名传递复杂类型。例如,以下 URI(参数别名中包含复杂类型)不受支持:

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"}              

SharePoint REST 服务参数别名语法

指定字典作为参数值

对于与以 Dictionary<String, String> 字典作为参数的方法相对应的 REST 端点,在查询字符串中将字典作为一组以逗号分隔的名称/值对传递。

Dictionary 参数 REST 服务语法
Dictionary<String, object> 表示为多值对象,命名为 KeyedPropertyValue,并具有以下字符串属性:
  • Key 多值对象的键

  • Value 对象的值

  • ValueType 对象的值类型。对于映射到现有实体数据模型 (EDM) 类型的简单值类型,REST 服务返回相应的 EDM 类型字符串;例如,"Edm.String"。如果不是,则 REST 服务返回由 Type.ToString 功能返回的值类型。

在查询字符串中指定参数值

如果您的 REST URI 以方法调用结束,则可以使用查询字符串语法来指定方法的参数值。例如:

http://<server>/<site>/_api/web/applyWebTemplate?template="STS#0"              

下图显示查询字符串中参数的 REST 服务语法。

查询字符串中参数的 REST 服务语法
指定静态方法和属性作为 REST 服务 URI

要构造与静态方法或属性对应的 URI,请使用 ECMAScript 对象模型中的对应 API 名称,该名称以命名空间声明开始并使用点记法 。例如,ECMAScript 客户端对象模型中的 SP.Utilities.Utility.getImageUrl(imageName) 将具有以下 REST 等效物:

http://server/site/_api/SP.Utilities.Utility.getImageUrl('imageName')            

但是,静态属性只能直接访问,不允许作为较大 URI 组成的一部分。例如,允许直接访问 REST 中的 SP.Utility.AssetsLibrary 方法,如下所示:

http://server/site/_api/SP.Utility.assetsLibrary/id            

但是,不允许将该资源位置用作更复杂 URI 的参数,如下面的示例所示:

http://server/site/_api/getList(~SP.Utility/assetsLibrary/id)            

下图显示 SharePoint REST 服务静态成员语法。

SharePoint REST 服务静态成员语法
 

总结

rest api对我来说,刚开始是个小白,到现在用的越来越顺手,其中msdn对我来说帮了不少的忙,没空就看msdn,觉得这篇文章讲的还是比较清楚的,就收集到自己的博客中了。

参考文章:

https://msdn.microsoft.com/zh-cn/library/office/dn292556.aspx

https://msdn.microsoft.com/ZH-CN/library/dn551366.aspx

https://msdn.microsoft.com/zh-cn/library/office/fp142380(v=office.15).aspx

https://msdn.microsoft.com/zh-cn/library/gg309461.aspx

https://msdn.microsoft.com/en-us/library/jj860569.aspx

博客地址: http://www.cnblogs.com/wolf-sun/
博客版权: 本文以学习、研究和分享为主,欢迎转载,但必须在文章页面明显位置给出原文连接。
如果文中有不妥或者错误的地方还望高手的你指出,以免误人子弟。如果觉得本文对你有所帮助不如【推荐】一下!如果你有更好的建议,不如留言一起讨论,共同进步!
再次感谢您耐心的读完本篇文章。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
SharePoint REST API - 确定REST端点URL
博客地址:http://blog.csdn.net/FoxDave SharePoint REST端点URI的结构 在你能够通过REST访问SharePoint资源之前,首先你要做的就是找出对应的URI端点,如果你对Client API熟悉,有些时候也可以参考Client API去猜测构建,例如。
1150 0
SharePoint REST API - 列表和列表项
博客地址:http://blog.csdn.net/FoxDave 本篇主要讲述如何用SharePoint REST操作列表和列表项。阅读本篇时请先了解前面讲述的REST介绍和基本操作。
1074 0
SharePoint 2016 入门视频教程
  之前一直有朋友让自己录一些SharePoint的入门视频,之前没有太多时间,一个巧合的机会收到CSDN学院的邮件,可以在CSDN上发布视频教程,自己就录了一些。说起录视频也是蛮辛苦的,每天下班吃完饭要哄一会儿孩子,九点左右打开电脑去厨房开始写ppt,查一些资料,然后自己先做一下实验,觉得没问题了再开始录制。
1446 0
SharePoint 跨域还原网站一则
博客地址:http://blog.csdn.net/foxdave 源端:执行PowerShell命令备份网站集 Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.
712 0
攻击SharePoint
前言Windows SharePointServices是Microsoft公司的一款用于Windows Server的免费附加软件它提供了基本的门户网站和企业内网功能,它包括由Web部件(由ASP.NET开发)组成的叫作web 部件页面的门户页面,团队站点,文档库以及项目子站点,带有版本控制的文档存储空间,以及基本的搜索功能。
1144 0
SPF和SharePoint Server的区别
SPF和SharePoint Server的区别 之前提到过,SharePoint Server是SPF的一个扩展。SharePoint Server的网站有一些SPF没有的功能,并且支持所有SPF的功能。
612 0
为SharePoint 2013配置Office Web Apps
最近看到新版的Office Web Apps Server开放下载了,貌似还是免费的,于是果断下载了。 Office Web Apps,相信大家都不陌生,那么如何让SharePoint文档库中的Office文档使用Office Web Apps打开呢? 如文档预览: 在线查看: 在线...
1151 0
SharePoint 搜索爬网第三方网站配置
介绍:SharePoint的搜索着实强大,而且最近用到SharePoint搜索第三方爬网,感觉收获挺大,而且网上资料没找到太多类似的,就小记录一下,分享给大家。       首先,我自己写了一个net页面,里面读取所有我需要内容,充当SharePoint爬网的数据源,对这个页面进行爬网,页面如下图:       然后,打开SharePoint管理中心,搜索设置,新建内容源Crawl,爬网http://moss:9000,如下图。
994 0
SharePoint随笔
关于SharePoint在企业信息化中的作用。 1、稍微了解一点Sharepoint的领导 都会认为SharePoint开发很快,总是希望用一些文档库、简单的几个表单或是搜索来解决它们的问题,总是把“这个应用很简单”放在嘴边。
962 0
1955
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载