永利集团娱乐官网才能运用 SharePoint 数据能源,过滤操作要求使用$filter

前边一篇我们介绍了 Office 365 REST API
的法定工具的行使,本篇大家来看一下 SharePoint REST API
自身的叙述、结构和使用情势,以及一些使用经验。

  1. SharePoint 2013使用_api来标识出 REST SERVICE,REST 瑟维斯其实是
    client.svc web service的一局部,但为了简化 REST U中华VI的布局以及裁减REST
    U路虎极光I的长度,使用 _api 来替代 _vti_bin/client.svc,例如, 你能够使用
    http://server/site/\_vti\_bin/client.svc/web/lists 来替代 http://server/site/\_api/web/lists;然而URL有256字符长度的限制,所以建议使用
    _api
    惯例;可参考此文章中的 Reference
    the SharePoint 2013 REST service in your endpoint URI
    章节;

第壹来探视SharePoint REST API 的概述:

SharePoint 2013 REST Syntax
Posters.pdf

      REST API 服务是在 SharePoint 二〇一二 中被引入的,官方认为 REST API
服务能够匹敌于现有的 SharePoint 客户端对象模型。开发人士可以应用其余帮助REST Web 请求的技能(C#,javascript,java,oc 等等)以长途情势与
SharePoint 数据开始展览交互。那也就象征,开发人士能够利用 REST
Web技术和规范开放数据协议(OData)语法从其 SharePoint
相关应用程序、化解方案和客户端应用程序执行 CRUD 操作。而针对中长途 Web
或运动接纳,必须先获得访问权限,才能运用 SharePoint 数据能源。

工具:Chrome浏览器中的 Advanced Rest Client Application插件

     在 REST API 出现以前,大家必要经过 client.svc 那几个 WCF 服务来呼吁
SharePoint
的列表数据,而且仅限于获取数据。数据的改动并不曾在这些服务中呈现。而通过
REST API,咱们得以成功前边提到的 CRUD 操作:使用OData 标准协会可达成REST 的 HTTP
请求,对应到相应的伸手方法,就能够对该财富进行读取或操作了。例如利用 GET
方法得到数据,使用 POST 方法来创立数量,使用 PUT 或 ME讴歌RDXGE
方法来更新数据,使用 DELETE 方法来删除数据。

 

      REST API 私下认可会再次回到 Atom
格式的多少,但是大家也得以依据供给设定重回 JSON
格式的多寡。小编个人更爱好处理 JSON 格式,JSON 数据转换为 C#
的对象,有多个很棒的网站:http://json2csharp.com/。通过那一个网站,我们得以把
JSON 数据间接转换为 C# 对象,节省了累累编纂 C# 基础代码的时间。

  1. Search REST API的query(GET)能够设置重返json格式的结果,存款和储蓄在data.d.query.PrimaryQueryResult.RelevantResults.Table.Rows.results中,results是个数据集合,序号从0早先;

  2. 应用REST
    API获取(GET)数据时,若再次来到多条记下,则再次回到值存款和储蓄在data.d.results中,results是个数据集合,序号从0早先,每2个result包括三个目的单元音信,例如:1个List
    Item的保有属性,如代码所示;若重回单条记录,则再次回到值存款和储蓄在data.d中;

接下去大家来看看 REST API 的布局组成:

永利集团娱乐官网 1永利集团娱乐官网 2

      端点的基本U奇骏L是:https://server/site/_api ,它是怀有 SharePoint
REST API 的根基,当中 server 代表服务器的名号,site
代表一定网站的名号或然路径。

{
"__metadata":{"id":"b719e719-e4cc-445c-9c7c-0250aba4338a",
"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)",
"etag":"\"4\"","type":"SP.Data.TasksListItem"},
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/RoleAssignments"}},
"AttachmentFiles":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/AttachmentFiles"}},
"ContentType":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/ContentType"}},
"FieldValuesAsHtml":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/FieldValuesAsHtml"}},
"FieldValuesAsText":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/FieldValuesAsText"}},
"FieldValuesForEdit":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/FieldValuesForEdit"}},
"File":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/File"}},
"Folder":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/Folder"}},
"ParentList":{"__deferred":{"uri":"https://gjq-11683d04060f3b.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'b44e6daf-ee1e-4249-987f-2f9305cdc884')/Items(1)/ParentList"}},
"FileSystemObjectType":0,
"Id":1,
"ContentTypeId":"0x0108005943A401D04CAD47AE81ABAA54AA39A3",
"Title":"Test",
"PredecessorsId":{"__metadata":{"type":"Collection(Edm.Int32)"},"results":[]},
"Priority":"(2) Normal",
"Status":"Not Started",
"PercentComplete":0.79,
"AssignedToId":11,
"TaskGroupId":null,
"Body":"<div></div>",
"StartDate":"2014-08-10T16:00:00Z",
"DueDate":"2014-08-27T16:00:00Z",
"RelatedItems":null,
"WorkflowLink":null,
"OffsiteParticipant":null,
"OffsiteParticipantReason":null,
"WorkflowOutcome":null,
"WorkflowName":null,
"GUID":"2c618f60-7fae-4689-a652-52458ae60dd6",
"ID":1,
"Modified":"2014-08-12T03:41:59Z",
"Created":"2014-08-11T01:57:18Z",
"AuthorId":11,
"EditorId":11,
"OData__UIVersionString":"4.0",
"Attachments":false
}

     
假设要访问特定的网站集,UCRUISERL是:https://server/site/\_api/site,要是要拜访特定的网站,UGL450L则是:https://server/site/\_api/web
。这二种是最常用的 API ,还有三种 API
能完成部分特定的功能,如:使用搜索服务:https://server/site/\_api/search,访问用户配置文件:http://server/site/_api/SP.UserProfiles.PeopleManager 等。

View Code

      下边大家以特定网站为例,来看一下 REST API
能做到哪些常见操作:

  1. 采用REST API的一些建议:

      (1)对列表和列表项的操作

  • If you’re not using the cross-domain library, include an X-RequestDigest header to send the form digest
    value in all POST requests and a content-lengthheader for POST requests that
    send data in the request body.

  • If you’re not making cross-domain requests, remove SP.AppContextSite(@target) and ?@target='<host web url>’ from the endpoint
    URI.

  • If you’re using OAuth, include an Authorization header (“Authorization”: “Bearer ” + <access token>) to
    send the OAuth access token.

  • If you want the server to return responses in Atom format, remove
    the “accept”: “application/json;
    odata=verbose” header.

       列表:

  1. 行使REST
    API获取对象音信时,只可以获得到当前级别音信,类似于Client Object
    Model,比如 /_api/web/lists能够得到全体list音信,但从不list
    item的新闻;例如:三个List的兼具属性,

       URL:http://&lt;网站 URL>/web/lists(guid'<列表 ID>’) 或 http://&lt;网站 URL>/web/lists/getbytitle(‘title of
list’)

永利集团娱乐官网 3永利集团娱乐官网 4

      
列表项集合:

{
"__metadata":
  {
  "id":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')",
  "uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')",
  "etag":"\"3\"",
  "type":"SP.List"
  },
"FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/FirstUniqueAncestorSecurableObject"}},
"RoleAssignments":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/RoleAssignments"}},
"ContentTypes":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/ContentTypes"}},
"CreatablesInfo":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/CreatablesInfo"}},
"DefaultView":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/DefaultView"}},
"DescriptionResource":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/DescriptionResource"}},
"EventReceivers":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/EventReceivers"}},
"Fields":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/Fields"}},
"Forms":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/Forms"}},
"InformationRightsManagementSettings":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/InformationRightsManagementSettings"}},
"Items":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/Items"}},
"ParentWeb":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/ParentWeb"}},
"RootFolder":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/RootFolder"}},
"TitleResource":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/TitleResource"}},
"UserCustomActions":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/UserCustomActions"}},
"Views":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/Views"}},
"WorkflowAssociations":{"__deferred":{"uri":"https://gjq-11683d04060f3f.sharepoint.com/BasicOperationApp/_api/Web/Lists(guid'9b64f833-6b28-4bf4-b02d-31e6f1d649e6')/WorkflowAssociations"}},
"AllowContentTypes":true,"BaseTemplate":100,"BaseType":0,"ContentTypesEnabled":false,"CrawlNonDefaultViews":false,"Created":"2014-08-12T05:22:25Z",
"DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
"Description":"",
"Direction":"none",
"DocumentTemplateUrl":null,
"DraftVersionVisibility":0,
"EnableAttachments":true,
"EnableFolderCreation":false,
"EnableMinorVersions":false,
"EnableModeration":false,
"EnableVersioning":false,
"EntityTypeName":"AccordionList",
"ForceCheckout":false,
"HasExternalDataSource":false,
"Hidden":false,
"Id":"9b64f833-6b28-4bf4-b02d-31e6f1d649e6",
"ImageUrl":"/_layouts/15itgen.png?rev=37",
"IrmEnabled":false,
"IrmExpire":false,
"IrmReject":false,
"IsApplicationList":false,
"IsCatalog":false,
"IsPrivate":false,
"ItemCount":3,
"LastItemDeletedDate":"2014-08-12T05:22:25Z",
"LastItemModifiedDate":"2014-08-13T06:16:41Z",
"ListItemEntityTypeFullName":"SP.Data.AccordionListItem",
"MultipleDataList":false,
"NoCrawl":false,
"ParentWebUrl":"/",
"ParserDisabled":false,
"ServerTemplateCanCreateFolders":true,
"TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
"Title":"Accordion"
}

       URL:http://&lt;网站 URL>/web/lists(guid'<列表 ID>’) /items 或 http://&lt;网站 URL>/web/lists/getbytitle(‘title of
list’)/items

View Code

     
钦定 ID 的列表项:

  1. REST Search
    API时,私下认可的rowlimit是10,即暗中同意重回10条记下;

  2. 行使REST
    API的POST方法创设新剧情时,再次回到的音讯囤积在data.d中,比如data.d.Id;

  3. REST API
    不可能改改文件夹的Name,详情请参考此处或者此处

      URL:http://&lt;网站 URL>/web/lists(guid'<列表 ID>’) /items(item id) 或 http://&lt;网站 URL>/web/lists/getbytitle(‘title of
list’)/items(item
id)

  1. REST
    API在更新file内容时,只好利用PUT,更新文件的metadata时,要求将文件作为八个item;

    If you want to update a file’s metadata, you’ll have to construct an endpoint that reaches the file as a list item. You can do this because each folder is also a list, and each file is also a list item. Construct an endpoint that looks like this: https:///_api/web/lists/getbytitle(‘Documents’)/items(). Working with lists and list items with REST explains how to update a list item’s metadata.

  2. 选用REST API获取item音信时,Look
    Up字段会爆发局地扭转,比如:有贰当中间名称为Zone的列,查询出来的数据中找不到Zone列,而会有个ZoneId字段,值为被询问item的ID值;假设想博得Zone的展现名称,可利用$expand来获得:

    1. 在$select=中能够写上Zone/Id,Zone/ColumnX;
    2. 在$expand=中务必写上Zone;

      注:Zone为当前列表的Look up字段;ColumnX为被询问列表的别样字段的内部名称;

      
如上 API 地址所示,大家得以经过List 本身的 GUID 恐怕 Title
来博取List,也许List的项集合的数据。当须要向列表中插入新项时,大家须求利用列表项集合
API,使用 POST
方法插入数据。而要求修改列表中某一项时,则须要运用钦赐列表项 API,使用
ME奥迪Q7GE 方法来更新数据。

10.
万一不采纳cross-domain类库,在开始展览POST操作时,都要在headers中添加X-RequestDigest参数,默许赋值是$(“#__REQUESTDIGEST”).val();

      
而关系到数量修改时,大家要求把措施类型,如 POST,ME瑞虎GE
等作为X-HTTP_Method
键的值添加到请求标头中。而且须要将请求窗体摘要值作为 X-RequestDigest
的值传递进入。该值的收获方式是:向 http://网站URL/\_api/contextinfo
发送全体空正文的 POST 请求,并在 contextinfo 终结点重临的 XML 中提取
d:FormDigestValue 节点的值。还有正是标头中的 IF-MATCH
键的值,须求赋值为列表或列表项的 etag 值。假若赋值为
“*”,则不会设想并发难题。

11.
过滤操作须要接纳$filter,例如,只需求Title字段以“B”起先的多寡:$filter=startswith(Title,
‘B’);只要求Title字段包蕴“B”的数据:$filter=substringof(‘B’,Title);

      
其它关于数据操作是亟需 POST 的内容:

永利集团娱乐官网 5

      
更新时,必须包罗 __metadata:type
和急需更新的字段。别的不必要立异的字段能够不进入。删除时,U路虎极光L指向该条记录即可。添加时,U路虎极光L指向记录集合,POST内容应涵盖__metadata:type 和要求插入的必填字段

  1. REST API – GET

           $.ajax({

                  url: "https://XXX.sharepoint.com/_api/web/lists/GetByTitle('XXX')/items",
                  type: "GET",
                  headers: {"Accept": "application/json;odata=verbose"},
                  success: function(data){
                      if(data.d.results){
                          var $selectObj = $("<select id='deptSelect'></select>");
                          $.each(data.d.results, function(index, item){
                              $selectObj.append($("<option></option>").attr("value", item.ID + item.Title).text(item.Title));
                          });
                          $("#getDiv").append($selectObj);
                          $("#getDiv").append("<br/>"+JSON.stringify(data.d.results));
                      }
                  },
                  error: function(xhr){
                      alert(xhr.status+': '+xhr.statusText);
                  }
              });
    

      (2)对文本和文书夹的操作

只顾:由于服务器端分页的界定,暗许情状下,每一次只好取得100条数据,但足以应用$top参数来钦点2遍要赢得多少条数据,但最大不能够超过5000;还足以运用__next来博取下一页的100条数据,请参见此处

       文件:

  1. REST API – POST (create)

            var newItem={

                  "__metadata":{"type": "SP.Data.Region_x0020_ApproversListItem"},
                  "Title": "Test Dept",
                  "Region": "GCN"
              };
    
              $.ajax({
                  url: "https://XXX.sharepoint.com/_api/web/lists/GetByTitle('XXX')/items",
                  type: "POST",
                  contentType: "application/json;odata=verbose",
                  data: JSON.stringify(newItem),
                  headers: {
                      "Accept": "application/json;odata=verbose",
                      "X-RequestDigest": $("#__REQUESTDIGEST").val()
                  },
                  success: function(data){
                      alert(JSON.stringify(data.d.Id));
                  },
                  error: function(xhr){
                      alert(xhr.status+': '+xhr.statusText);
                  }
              });
    
  2. REST API – POST (update)

            var updatedItem={

                  "__metadata":{"type":"SP.Data.Region_x0020_ApproversListItem"},
                  "Title": "Test Dept Again"
              };
    
            $.ajax({
                  url: "https://XXX.sharepoint.com/_api/web/lists/GetByTitle('XXX')/items(40)",
                  type: "POST",
                  contentType: "application/json;odata=verbose",
                  data: JSON.stringify(updatedItem),
                  headers:{
                      "ACCEPT": "application/json;odata=verbose",
                      "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                      "X-HTTP-METHOD": "MERGE",
                      "IF-MATCH": "*"
                  },
                  success: function(){ //此处没有data参数
                      getListItem();
                  },
                  error: function(xhr){
                      alert(xhr.status+': '+xhr.statusText);
                  }
              });
    
  3. REST API – DELETE

            $.ajax({

                  url: "https://XXX.sharepoint.com/_api/web/lists/GetByTitle('XXX')/items(43)",
                  type: "POST",
                  headers:{
                      "Accept": "application/json;odata=verbose",
                      "X-Http-Method": "DELETE",
                      "X-RequestDigest": $("#__REQUESTDIGEST").val(),
                      "If-Match": "*"
                  },
                  success: function(data){
                      alert(JSON.stringify(data));
                  },
                  error: function(xhr){
                      alert(xhr.status+': '+xhr.statusText);
                  }
              });
    

       URL:http://&lt;网站
URL>/_api/web/getfilebyserverrelativeurl(‘/<文件夹名称>/<文件名称>’)

16.
在展开POST操作时,需求先获得metadata中的type属性值,方法是:http://XXXX/sites/XXX/\_api/web/lists/getbytitle('listName')?$select=ListItemEntityTypeFullName

       文件列表:

  1. SharePoint 2015及 Office 365支撑 REST
    API批量操作(Batch),可参照此处

  2. REST API
    使用的uri中,SharePoint名称(比如,列表名,列名)是大大小小写敏感的,oData的称谓是深浅写不灵敏;在运用$filter等原则语句进行筛选比较时,非数字类型值必要添加单引号,比如
    userName eq ‘ABC’;

  3. 应用REST API获取当前用户的报到名:

  4. 始建一个 Custom REST
    Service,可参考此文章;主要一点是:无需修改Web
    Config文件,只须求在.svc文件宣称中加入以下代码即可:

    <%@ ServiceHost Language="C#" Debug="true" Service="SPRESTService.CustomRESTService, $SharePoint.Project.AssemblyFullName$"

    CodeBehind="CustomRESTService.svc.cs" 
    Factory="Microsoft.SharePoint.Client.Services.MultipleBaseAddressWebServiceHostFactory,
    Microsoft.SharePoint.Client.ServerRuntime, Version=15.0.0.0, Culture=neutral,
    PublicKeyToken=71e9bce111e9429c"%>
    

       URL:http://&lt;网站
URL>/_api/web/getfolderbyserverrelativeurl(‘/<文件夹名称>’)/files

如需在注脚中选拔 token 符
“$SharePoint.Project.AssemblyFullName$”,须求在project文件(.csproj文件)
中参与以下代码:

       文件夹:

<PropertyGroup>
    ...
    <SandboxedSolution>False</SandboxedSolution>
    <TokenReplacementFileExtensions>svc</TokenReplacementFileExtensions>
</PropertyGroup>

       URL:http://&lt;网站
URL>/_api/web/getfolderbyserverrelativeurl(‘/<文件夹名称>’)

  1. 在Custom REST Service时, 每种 OperationContract的
    Name属性用于标识那一个操作,是唯一的,在再次来到值中得以反映出来,重返值为
    Name + ‘Result’,例如,在ajax回调函数中利用时即为
    response.GetAllPresidentsResult
    ;UriTemplate属性是造访此操作的门路,也是唯一的;

       通过上述 API
操作,大家得以成功文件和文书夹的读取,上传和修改等操作。

永利集团娱乐官网 6

       当需求向文书档案库插入文书档案时,UPRADOL
是:http://&lt;site
url>/_api/web/GetFolderByServerRelativeUrl(‘/Shared
Documents’)/Files/add(url=’a.txt’,overwrite=true),那样,大家就把公文以
a.txt 为寄放名称插入到了 Shared Documents
文书档案库中。而文书档案内容的上传进度是:文件读取为 Stream,放入 POST
内容中。文件还有其它过多中操作方法,如更新,签出,签入,删除等。

  1. 若要获取1个web根目录下的装有folder,能够采用一下REST API:

    http://site url/_api/web/folders

      (3)对用户、组和剧中人物的操作

获取的结果正是在SPD中看看的旗帜:

       组:

永利集团娱乐官网 7

       URL:http://&lt;网站 URL>/_api/web/sitegroups(<组 ID>)

REST重返的结果或然还会含有一下以”_vti_”起先的文档库或列表地址,那一个是FrontPage的遗产物,无需在意,详情可参看此文章

       用户:

  1. SharePoint REST API中的 /folders 和 /files
    接口都只可以取妥帖前文件夹下的 子文件夹 恐怕 文件,而无法递归读取全数子文件夹 或 文件;

    http://host url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl(‘/sites/jacky/Documents’)/Files
    http://host url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl(‘/sites/jacky/Documents’)/Folders

       URL:http://&lt;网站
URL>/_api/web/siteusers(@v)?@v='<登录名>’

而 /items 接口却能够获取叁个 list 或然 library
全部item,包蕴文件和文书夹;

       角色:

http://host url/sites/jacky/_api/Web/Lists(guid'9957f1e6-a35a-4888-a770-d5325c5cfe74')/Items

       URL:http://&lt;网站
URL>/_api/web/roledefinitions(<剧中人物定义
ID>)

  1. $expand
    相当于扩充查询,将子查询对象的结果集成到眼下这一次调用中来,比如:

      (4)对用户配置文件的操作

使用 http://host
url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl(‘/sites/jacky/Documents’)

接口我们得以获取Documents 这么些文件夹的一对消息,重回结果如下:

       URL:http://&lt;网站
url>/_api/sp.userprofiles.peoplemanager

永利集团娱乐官网 8

      (5)对字段的操作

即便加上$expand 对象,将 REST UENVISIONI
改为:http://host
url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl(‘/sites/jacky/Documents’)?$expand=Folders,Files
 即
加上了 查询Folders 和 Files的子语句,重回的结果为:

       URL:http://&lt;网站 url>/_api/web/fields(‘<字段 id>’) 或 http://&lt;网站 url>/_api/web/lists(guid'<列表 id>’)/fields(‘<字段 id>’)

永利集团娱乐官网 9

       上边我们介绍了列表,文件夹等类型 API
的地址构造,接下去大家看看这一个请求地址中允许的询问参数都有啥:       

一定于,在查询当前文件夹音讯的同时,也开始展览了上边五个查询,并将结果一回性再次来到:

       (1)$select 参数

http://host url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl('/sites/jacky/Documents')/Files
http://host url/sites/jacky/_api/Web/GetFolderByServerRelativeUrl('/sites/jacky/Documents')/Folders

       如 SQL 中 Select 的使用办法,那里的 $select
也是确定请求重临的结果中需求包罗怎么样字段,使用办法是:_api/web/lists/getByTitle(‘Books’)/items?$select=Author,Title,ISBN,那样大家就会在取得Books那么些列表时,只取得笔者,书名和ISBN多少个有效字段。

25.
在利用$select时,借使急需选用的性能位于二个成团(例如
results)中,那么在途径中能够忽略掉 results
(此为虚拟节点),直接写供给的性格,比如下图,假若急需选择Title属性,不必要写成:$select=ListItemAllFields/RoleAssignments/results/Member/Users/results/Title,直接写成
$select=ListItemAllFields/RoleAssignments/Member/Users/Title
即可;

       (2)$filter 参数

永利集团娱乐官网 10

       如 SQL 中 Where 的运用办法,那里的 $filter
是用来筛选数据的筛选标准,使用格局是:_api/web/lists/getByTitle(‘Books’)/items?$filter=Author
eq ‘马克 特温’,这样我们就能取到 Books 列表中,Author 为 马克 特温的多寡。

26. 

       (3)$expand 参数

      
这几个参数用于钦点重回联接列表中的哪些投射字段。使用方式是:_api/web/lists/getByTitle(‘Books’)/items?$select=Title,PublishedBy/Name&$expand=PublishedBy,那里的炫耀字段是
PublishedBy。

       (4)$top 参数

      
那几个参数用户内定再次回到结果集中的前N项,使用方法是:_api/web/lists/getByTitle(‘Books’)/items?$top=2,那样大家就会再次回到这些结果集中的前两项(如不足两项则赶回全体多少)。

       (5)$skip 参数

      
那么些参数用于在结果集中跳过内定数量的项,而回到剩余的项。使用方法是:_api/web/lists/getByTitle(‘Books’)/items?$skip=2,那样我们就会在回到结果中跳过前两项而回到其他的项,如结果不足两项,则赶回空结果集。

       (6)$orderby 参数

       那些参数用于对结果集实行排序,如 SQL
中运用方法,分为升序和降序二种办法,以 asc 和 desc
关键字来标识。使用办法是:_api/web/lists/getByTitle(‘Books’)/items?$orderby=ID
desc。那样我们回去的结果集,就会以 ID 为标准来降序排列。 

       下边那张表,涵盖了 SharePoint REST API
中差不多全体的询问条件和数字、字符等的相比重庆大学字。例如 $filter=Author eq
‘马克 特温’,正是筛选 Author 等于 马克 特温 的项,而 Author ne ‘Mark特温’,则是筛选不等的项。这是指向字符串的可比操作,而针对性数字的则囊括 
lt(小于)、le(小于等于)、gt(大于)、ge(大于等于)、eq(等于)和
ne(不对等)。还有针对日期和岁月的可比符,见表中表明。

       永利集团娱乐官网 11 

       最后还涉及到1个授权的标题,如前方所说,远程访问都亟需先授权才能访问能源。大家能够因而OAuth 授权的法子来成功应用授权和身份验证。将获得的 OAuth
访问令牌加入到请求标头中。这里大家不做详细介绍了。关于
API本人的利用进程,和其余 API
没什么差别,那里就不做详细介绍了。就是3个发出请求,获得再次回到结果(Atom或JSON),然后解析结果的历程。

       那样大家就把 SharePoint REST API
的三结合和核心的施用方式介绍完了,希望对我们在 Windows 商店应用中央银行使
SharePoint REST API 有所支持,感谢。

       

 

 

 

 

     

相关文章