开发者社区> 霖雨001> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

SharePoint 2013 Search REST API 使用示例

简介:   前言:在SharePoint2013中,提供Search REST service搜索服务,你可以在自己的客户端搜索方法或者移动应用程序中使用,该服务支持REST web request。你可以使用KeyWord Query Language(KQL)或者FAST Query Language(FQL)来对Search REST Service进行搜索查询,并且,试用与远程客户端应用程序、移动应用程序和其他应用程序。
+关注继续查看

  前言:在SharePoint2013中,提供Search REST service搜索服务,你可以在自己的客户端搜索方法或者移动应用程序中使用,该服务支持REST web request。你可以使用KeyWord Query Language(KQL)或者FAST Query Language(FQL)来对Search REST Service进行搜索查询,并且,试用与远程客户端应用程序、移动应用程序和其他应用程序。

一、   Search REST service

支持方式:

Search REST service支持 HTTP POST方式和 HTTP GET requests方式

 

GET requests

URL:http://server/_api/search/query

Get方式你有两种传参方式,如下:

http://server/_api/search/query?query_parameter=value&query_parameter=value

http://server/_api/search/query(query_parameter=value&query_parameter=<value>)

POST requests

URL:http://server/_api/search/postquery

在Post方式中,你可以使用JavaScript Object Notation (JSON)方式传参

 

Post方式的场景有三种:

Get方式传参,Url超出长度限制,只有使用Post方式;

查询条件非常复杂,Get方式难以满足需要,使用Post方式;

对于某些特定参数,只支持Post方式。

二、Get方式查看返回XML

1、  在我配置好的搜索页面上,搜索“北京”,如下图,有4个结果

2、  使用Get方式返回xml,在_api/search/query 后面添加querytext参数”北京”的Escape值“%E5%8C%97%E4%BA%AC”

http://URL/_api/search/query?querytext='%E5%8C%97%E4%BA%AC'

 

(返回的xml截图)

3、单个项目的XML节点

<d:element m:type="SP.SimpleDataRow">
  <d:Cells>
    <d:element m:type="SP.KeyValue">
      <d:Key>Rank</d:Key>
      <d:Value>10.3831567764282</d:Value>
      <d:ValueType>Edm.Double</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>DocId</d:Key>
      <d:Value>52</d:Value>
      <d:ValueType>Edm.Int64</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>WorkId</d:Key>
      <d:Value>52</d:Value>
      <d:ValueType>Edm.Int64</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Title</d:Key>
      <d:Value>北京</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Author</d:Key>
      <d:Value>系统帐户</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Size</d:Key>
      <d:Value>120</d:Value>
      <d:ValueType>Edm.Int64</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Path</d:Key>
      <d:Value>http://url/DocLib/北方城市/北京.txt</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Description</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>Write</d:Key>
      <d:Value>2013-08-21T02:22:46.0000000Z</d:Value>
      <d:ValueType>Edm.DateTime</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>CollapsingStatus</d:Key>
      <d:Value>0</d:Value>
      <d:ValueType>Edm.Int64</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>HitHighlightedSummary</d:Key>
      <d:Value>
        <c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都<c0>北京</c0>是首都
      </d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>HitHighlightedProperties</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>contentclass</d:Key>
      <d:Value>STS_ListItem_DocumentLibrary</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>PictureThumbnailURL</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ServerRedirectedURL</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ServerRedirectedEmbedURL</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ServerRedirectedPreviewURL</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>FileExtension</d:Key>
      <d:Value>txt</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ContentTypeId</d:Key>
      <d:Value>0x01010027E858607844AC42AD371DFAA2B2557C</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ParentLink</d:Key>
      <d:Value>http://url/DocLib/北方城市</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ViewsLifeTime</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>ViewsRecent</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SectionNames</d:Key>
      <d:Value/>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SectionIndexes</d:Key>
      <d:Value/>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SiteLogo</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SiteDescription</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>deeplinks</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>importance</d:Key>
      <d:Value>0</d:Value>
      <d:ValueType>Edm.Int64</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SiteName</d:Key>
      <d:Value>http://url</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>IsDocument</d:Key>
      <d:Value>true</d:Value>
      <d:ValueType>Edm.Boolean</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>LastModifiedTime</d:Key>
      <d:Value>2013-08-21T02:22:46.0000000Z</d:Value>
      <d:ValueType>Edm.DateTime</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>FileType</d:Key>
      <d:Value>txt</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>IsContainer</d:Key>
      <d:Value>false</d:Value>
      <d:ValueType>Edm.Boolean</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>WebTemplate</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>SecondaryFileExtension</d:Key>
      <d:Value>txt</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>docaclmeta</d:Key>
      <d:Value m:null="true"/>
      <d:ValueType>Null</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>OriginalPath</d:Key>
      <d:Value>http://url/DocLib/北方城市/北京.txt</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>PartitionId</d:Key>
      <d:Value>0c37852b-34d0-418e-91c6-2ac25af4be5b</d:Value>
      <d:ValueType>Edm.Guid</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>UrlZone</d:Key>
      <d:Value>1</d:Value>
      <d:ValueType>Edm.Int32</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>AAMEnabledManagedProperties</d:Key>  <d:Value>AttachmentURI;deeplinks;DefaultEncodingURL;ExternalMediaURL;HierarchyUrl;OrgParentUrls;OrgUrls;OriginalPath;ParentLink;Path;PictureThumbnailURL;PictureURL;PublishingImage;recommendedfor;ServerRedirectedEmbedURL;ServerRedirectedPreviewURL;ServerRedirectedURL;SiteLogo;SitePath;SPSiteURL;UserEncodingURL</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>RenderTemplateId</d:Key>
      <d:Value>~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_Default.js</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
    <d:element m:type="SP.KeyValue">
      <d:Key>piSearchResultId</d:Key>
      <d:Value>3_1</d:Value>
      <d:ValueType>Edm.String</d:ValueType>
    </d:element>
  </d:Cells>
</d:element>
View Code

4、解疑,我看到这个结果,很奇怪,为什么我的网站中有4条结果,REST返回了5条,详细查看每个SimpleDateRow发现,最后一个居然是之前做BCS测试的时候的结果,XML附后。 

<d:element m:type="SP.KeyValue">
<d:Key>Path</d:Key>
<d:Value>bdc3://blobdatacontent_blobdatacontent/Default/00000000%252D0000%252D0000%252D0000%252D000000000000/1394/BlobDataContent/1396?s_id=iAwAAAA==&s_ce=048g24810001020408000h20005s</d:Value>
<d:ValueType>Edm.String</d:ValueType>
</d:element>

 

三、   Get 方式 - XML调用实例

1、  调用效果图,如下:

2、  后台方法:

 1 public void gvDateBind()
 2 {
 3     string keywords = "'" + System.Web.HttpUtility.UrlEncode(tbKeyWord.Text) + "'";
 4     string strRes = "http://url/_api/search/query?querytext=" + keywords;
 5 
 6     WebClient wc = new WebClient();
 7     wc.Encoding = System.Text.Encoding.UTF8;
 8     NetworkCredential nc = new NetworkCredential("username", "password", "ad");
 9     wc.Credentials = nc;
10     string str = wc.DownloadString(strRes);
11 
12     XmlDocument doc = new XmlDocument();
13     doc.LoadXml(str);
14     XmlNodeList xnodelist = doc.GetElementsByTagName("d:Rows");
15     XmlNode node = xnodelist[0];
16 
17     DataTable dt = new DataTable();
18     dt.Columns.Add("标题");
19     dt.Columns.Add("作者");
20     dt.Columns.Add("描述");
21     dt.Columns.Add("链接");
22 
23     XmlNodeList xlist = node.ChildNodes;
24 
25     foreach (XmlNode xnode in xlist)
26     {
27         XmlNodeList nn = xnode.ChildNodes[0].ChildNodes;
28         DataRow dr = dt.NewRow();
29 
30         foreach (XmlNode nnode in nn)
31         {
32             switch (nnode.ChildNodes[0].InnerText)
33             {
34                 case "Title":
35                     dr["标题"] = nnode.ChildNodes[1].InnerText;
36                     break;
37                 case "Author":
38                     dr["作者"] = nnode.ChildNodes[1].InnerText;
39                     break;
40                 case "HitHighlightedSummary":
41                     dr["描述"] = nnode.ChildNodes[1].InnerText;
42                     break;
43                 case "Path":
44                     dr["链接"] = nnode.ChildNodes[1].InnerText;
45                     break;
46             }
47         }
48         dt.Rows.Add(dr);
49     }
50 
51     gvSearchResult.DataSource = dt;
52     gvSearchResult.DataBind();
53 }

Get方式-Xml调用示例

 四、   POST方式 - JSON调用实例

1、调用结果显示

 

2、核心代码

 

$.ajax(
               {
                   url: http://url/_api/search/postquery,
                   type: "Post",
                   dataType: "application/json;odata=verbose",
                   data: JSON.stringify({
                       'request': {
                           'Querytext': queryText,
                           'StartRow': 1,
                           'RowLimit': 8,
                           'SelectProperties': {
                               'results': ['Title', 'ContentSource', 'DisplayAuthor', 'Path']
                           },
                           'TrimDuplicates': true,
                           'Refiners': 'companies,contentclass,FileType(filter=6/0/*)',
                           //'RefinementFilters': { 'results': ['filetype:equals("txt")'] }
                       }
                   }),
                   headers: {
                       "accept": "application/json;odata=verbose",
                       "content-type": "application/json;odata=verbose",
                       "X-RequestDigest": xRequestDigest
                   },
                   complete: ProcessSearchResult
               });

注:本来自己想写个调用JSON的博客,但是看到CSDN上有人写过了,自己就不写了,把最重要的那段代码贴给大家参考,大家有兴趣可以参考下,博客地址附后!

 

五、   常用的查询参数:

查询关键字(querytext

http://server/_api/search/query?querytext='sharepoint'

 

JSON实例:

{

'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint'

}

 

起始行(StartRow

http://server/_api/search/query?querytext='sharepoint'&startrow=10

 

JSON实例:

{

'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'StartRow' : '10'

}

 

返回行限制(RowLimit

http://server/_api/search/query?querytext='sharepoint'&rowlimit=30

 

JSON实例:

{

'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'RowLimit' : '30'

}

 

选择属性(SelectProperties

http://server/_api/search/query?querytext='sharepoint'&selectproperties='Title,Author'

 

JSON实例:

{

'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'SelectProperties' : {

    'results' : [

          'Title,

          Author'

          ]

}

}

 

扩展名(RefinementFilters

http://server/_api/search/query?querytext='sharepoint'&refinementfilters='fileExtension:equals("docx")'

 

JSON实例:

{

'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'RefinementFilters' : {

'results' : ['fileExtension:equals("docx")']

}

}

 

排序(SortList

http://server/_api/search/query?querytext='sharepoint'&sortlist='rank:descending,modifiedby:ascending'

 

JSON实例:

{

'__metadata' : {'type':'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'SortList' :

{

    'results' : [

        {

                'Property':'Created',

                'Direction': '0'

        },

        {

                'Property':'FileExtension',

                'Direction': '1'

        }

    ]

}

}

 

返回总长度(SummaryLength

http://server/_api/search/query?querytext='sharepoint'&summarylength=150

 

JSON实例:

{

'__metadata':{'type':'Microsoft.Office.Server.Search.REST.SearchRequest'},

'Querytext' : 'sharepoint',

'Summarylength' : '150'

}

 

参考链接:

1、SharePoint Search REST API overview

http://msdn.microsoft.com/en-us/library/jj163876.aspx

2、Jquery(Ajax) 调用 SharePoint 2013 Search Rest API 并使用Josn反回结果并简单显示

http://blog.csdn.net/abrahamcheng/article/details/8470834

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

相关文章
Spring Boot的TestRestTemplate使用
Spring Boot的TestRestTemplate使用
75 0
SharePoint 2013 网站搜索规则的使用示例
前言   SharePoint 2013搜索中,有一个非常好用的细化搜索结果的功能,就是“查询规则”。可以通过对于某些特定查询时,起到细化显示结果的作用。下面,我们简单的介绍一下该功能的使用和效果。   1、通常SharePoint搜索,我们在管理中心的搜索中心,对内容源进行爬网,然后在搜索核心...
987 0
SharePoint 2013 开发——开发并部署Provider-hosted APP
博客地址:http://blog.csdn.net/FoxDave 本篇我们用Visual Studio创建并部署一个SharePoint Provider-hosted应用程序。
676 0
SharePoint 2013 搜索高级配置(Search Scope)
原文:SharePoint 2013 搜索高级配置(Search Scope)   前言:SharePoint 2013集成了Fast Search,而后在配置上与2010及之前版本都有一些区别,如果需要开启搜索的文档,请参考我之前写的博客,博客地址附后。
811 0
SharePoint 2013 App Remote Event Receivers
  当我们在使用App的时候,就会发现一些问题,比如那些网站部署、更新或者卸载了,我们很关心我们的App是否有人用,这就需要远程事件接收器了。   1、在我们的测试App的解决方案上选中鼠标,按F4弹出属性,选中我们需要的处理应用程序,选中True;同时,VS会自动创建一个解决方案,让我们在里面写远程事件接收器的相关代码。
903 0
SharePoint 2013 搜索高级配置(Search Scope)
  前言:SharePoint 2013集成了Fast Search,而后在配置上与2010及之前版本都有一些区别,如果需要开启搜索的文档,请参考我之前写的博客,博客地址附后。下面,我们开始了解下,SharePoint2013里面的搜索配置。
969 0
+关注
霖雨001
霖雨,微软最有价值专家SharePoint方向,CSDN学院讲师。2010年开始致力于SharePoint相关技术研究,精通SharePoint 环境搭建、架构、实施、开发、运维、排错等技术。
274
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载