AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

SharePoint REST API - 列表和列表项

2017-08-23 1220
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 博客地址：http://blog.csdn.net/FoxDave本篇主要讲述如何用SharePoint REST操作列表和列表项。阅读本篇时请先了解前面讲述的REST介绍和基本操作。

博客地址：http://blog.csdn.net/FoxDave

本篇主要讲述如何用SharePoint REST操作列表和列表项。阅读本篇时请先了解前面讲述的REST介绍和基本操作。

废话不多说了，下面开始。

用REST获取列表属性

当你知道一个列表的GUID时，你可以用下面的请求来获取这个列表对象。

url: http://site url/_api/web/lists(guid'list GUID'),
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"
如果你知道一个列表的标题，那么可以用下面的请求。 

url: http://site url/_api/web/lists/GetByTitle('Test')
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"
下面是一个通过请求返回的XML结果示例，基本是跟API的属性对应的，就不做过多讲解了。 

<content type="application/xml">
    <m:properties>
        <d:AllowContentTypes m:type="Edm.Boolean">true</d:AllowContentTypes> 
        <d:BaseTemplate m:type="Edm.Int32">100</d:BaseTemplate> 
        <d:BaseType m:type="Edm.Int32">0</d:BaseType> 
        <d:ContentTypesEnabled m:type="Edm.Boolean">false</d:ContentTypesEnabled> 
        <d:Created m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:Created> 
        <d:DefaultContentApprovalWorkflowId m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:DefaultContentApprovalWorkflowId> 
        <d:Description>A list created by Project Based Retention used to store Project Policy Items.</d:Description> 
        <d:Direction>none</d:Direction> 
        <d:DocumentTemplateUrl m:null="true" /> 
        <d:DraftVersionVisibility m:type="Edm.Int32">0</d:DraftVersionVisibility> 
        <d:EnableAttachments m:type="Edm.Boolean">true</d:EnableAttachments> 
        <d:EnableFolderCreation m:type="Edm.Boolean">false</d:EnableFolderCreation> 
        <d:EnableMinorVersions m:type="Edm.Boolean">false</d:EnableMinorVersions> 
        <d:EnableModeration m:type="Edm.Boolean">false</d:EnableModeration> 
        <d:EnableVersioning m:type="Edm.Boolean">false</d:EnableVersioning> 
        <d:EntityTypeName>ProjectPolicyItemList</d:EntityTypeName> 
        <d:ForceCheckout m:type="Edm.Boolean">false</d:ForceCheckout> 
        <d:HasExternalDataSource m:type="Edm.Boolean">false</d:HasExternalDataSource> 
        <d:Hidden m:type="Edm.Boolean">true</d:Hidden> 
        <d:Id m:type="Edm.Guid">74de3ff3-029c-42f9-bd2a-1e9463def69d</d:Id> 
        <d:ImageUrl>/_layouts/15/images/itgen.gif</d:ImageUrl> 
        <d:IrmEnabled m:type="Edm.Boolean">false</d:IrmEnabled> 
        <d:IrmExpire m:type="Edm.Boolean">false</d:IrmExpire> 
        <d:IrmReject m:type="Edm.Boolean">false</d:IrmReject> 
        <d:IsApplicationList m:type="Edm.Boolean">false</d:IsApplicationList> 
        <d:IsCatalog m:type="Edm.Boolean">false</d:IsCatalog> 
        <d:IsPrivate m:type="Edm.Boolean">false</d:IsPrivate> 
        <d:ItemCount m:type="Edm.Int32">0</d:ItemCount> 
        <d:LastItemDeletedDate m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:LastItemDeletedDate> 
        <d:LastItemModifiedDate m:type="Edm.DateTime">2012-06-26T23:15:59Z</d:LastItemModifiedDate> 
        <d:ListItemEntityTypeFullName>SP.Data.ProjectPolicyItemListItem</d:ListItemEntityTypeFullName> 
        <d:MultipleDataList m:type="Edm.Boolean">false</d:MultipleDataList> 
        <d:NoCrawl m:type="Edm.Boolean">true</d:NoCrawl> 
        <d:ParentWebUrl>/</d:ParentWebUrl> 
        <d:ServerTemplateCanCreateFolders m:type="Edm.Boolean">true</d:ServerTemplateCanCreateFolders> 
        <d:TemplateFeatureId m:type="Edm.Guid">00bfea71-de22-43b2-a848-c05709900100</d:TemplateFeatureId> 
        <d:Title>Project Policy Item List</d:Title> 
    </m:properties>
  </content>
注意ListItemEntityTypeFullName这个属性，它重要的原因是当你需要创建或更新列表项时，必须传递该参数作为元数据metadata中的type属性。

使用REST操作列表

创建一个列表的请求如下所示。

url: http://site url/_api/web/lists
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
 'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body
下面的代码演示了如何通过MERGE方法更新列表。 

url: http://site url/_api/web/lists(guid'list GUID')
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'Title': 'New title' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH": etag or "*"
    X-HTTP-Method: MERGE,
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body
接下来的代码演示了如何向一个列表中添加自定义字段。 

Url: url: http://site url/_api/web/lists(guid'list GUID')/Fields
Method:POST
Body: { '__metadata': { 'type': 'SP.Field' }, 'Title': 'field title', 'FieldTypeKind': FieldType value,'Required': 'true/false', 'EnforceUniqueValues': 'true/false','StaticName': 'field name'}
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    content-type: "application/json;odata=verbose"
    content-length:length of post body
接下来是如何删除一个列表。 
url: http://site url/_api/web/lists(guid'list GUID')
method: POST
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH: etag or "*"
    X-HTTP-Method: DELETE
使用REST操作列表项
下面的示例展示了如何获取列表中所有的列表项。 

url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"
注意在查询列表项时，$skip需要改用$skiptoken。

下面的示例展示了如何通过列表项ID获取指定的列表项。

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"
下面的XML是一个请求返回的示例。 

<content type="application/xml">
<m:properties> 
<d:FileSystemObjectType m:type="Edm.Int32">0</d:FileSystemObjectType>
<d:Id m:type="Edm.Int32">1</d:Id>
<d:ID m:type="Edm.Int32">1</d:ID>
<d:ContentTypeId>0x010049564F321A0F0543BA8C6303316C8C0F</d:ContentTypeId>
<d:Title>an item</d:Title>
<d:Modified m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Modified>
<d:Created m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Created>
<d:AuthorId m:type="Edm.Int32">11</d:AuthorId>
<d:EditorId m:type="Edm.Int32">11</d:EditorId>
<d:OData__UIVersionString>1.0</d:OData__UIVersionString>
<d:Attachments m:type="Edm.Boolean">false</d:Attachments>
<d:GUID m:type="Edm.Guid">eb6850c5-9a30-4636-b282-234eda8b1057</d:GUID>
</m:properties>
</content>
下面的代码演示如何创建一个列表项。 

url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body
注意这里你需要知道上面提到的ListItemEntityTypeFullName值并把它作为type参数传递。
下面的代码展示了如何更新一个列表项。 
url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'TestUpdated'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"MERGE",
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body
接下来是删除列表项。 
url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"DELETE"
另外说明一点，在用REST操作列表项时，如何需要考虑版本，可以使用ETag属性，具体可以到必应搜索了解一下，这里不做过多阐述了。
文章标签：
API
数据格式
JSON
网络架构
XML
关键词：
API REST
API列表
rest API列表
sharepoint API
sharepoint rest API
justinliu927
目录
相关文章
爱的不是纯牛奶-47754
|
24天前
|
缓存 API 网络架构
掌握现代API开发：GraphQL vs REST
【10月更文挑战第24天】本文深入探讨了现代API开发中两种主流技术——GraphQL和REST的设计理念、技术特点及实际开发中的对比分析。GraphQL通过声明式数据请求和强类型系统提供更高的灵活性和性能，而REST则以其无状态特性和成熟的生态系统见长。文章还讨论了两者在客户端-服务器交互、安全性和工具支持方面的优劣，帮助开发者根据项目需求做出明智选择。
爱的不是纯牛奶-47754
28 2
技术交流18179014480
|
24天前
|
JSON API 数据格式
店铺所有商品列表接口json数据格式示例（API接口）
当然，以下是一个示例的JSON数据格式，用于表示一个店铺所有商品列表的API接口响应
技术交流18179014480
41 1
游客j4mujezz7vm7y
|
2月前
|
JSON 中间件 API
开发REST API3-11
开发REST API3-11
游客j4mujezz7vm7y
48 4
bzf4tpxf3rljg
|
2月前
|
JSON JavaScript API
编写REST API
编写REST API
bzf4tpxf3rljg
61 2
winx_19970108018
|
1月前
|
API 数据安全/隐私保护 开发者
淘宝 API：关键词搜商品列表接口，助力商家按价格销量排序分析数据
此接口用于通过关键词搜索淘宝商品列表。首先需在淘宝开放平台注册并创建应用获取API权限，之后利用应用密钥和访问令牌调用接口。请求参数包括关键词、页码、每页数量、排序方式及价格区间等。返回结果含总商品数量及具体商品详情。使用时需注意签名验证及官方文档更新。
winx_19970108018
76 0
何雨晨
|
1月前
|
Java API Maven
使用 Smart-doc 记录 Spring REST API
使用 Smart-doc 记录 Spring REST API
何雨晨
47 0
wljslmz
|
3月前
|
XML 安全 API
REST 和 SOAP API 有什么区别？
【8月更文挑战第31天】
wljslmz
200 0
天外归云
|
API
SharePoint API测试系列——Records.BypassLocks测试
转载请注明出自天外归云的博客园：http://www.cnblogs.com/LanTianYou/ 对于SharePoint中已经是Record的Item，我们想要修改他的属性，这在UI界面是无法完成的： 这时需要通过Records.BypassLocks API来完成。
天外归云
924 0
winx_19970108018
|
11天前
|
JSON API 数据格式
淘宝 / 天猫官方商品 / 订单订单 API 接口丨商品上传接口对接步骤
要对接淘宝/天猫官方商品或订单API，需先注册淘宝开放平台账号，创建应用获取App Key和App Secret。之后，详细阅读API文档，了解接口功能及权限要求，编写认证、构建请求、发送请求和处理响应的代码。最后，在沙箱环境中测试与调试，确保API调用的正确性和稳定性。
winx_19970108018
45 1
技术交流18179014480
|
23天前
|
供应链 数据挖掘 API
电商API接口介绍——sku接口概述
商品SKU（Stock Keeping Unit）接口是电商API接口中的一种，专门用于获取商品的SKU信息。SKU是库存量单位，用于区分同一商品的不同规格、颜色、尺寸等属性。通过商品SKU接口，开发者可以获取商品的SKU列表、SKU属性、库存数量等详细信息。
技术交流18179014480
48 1

热门文章

最新文章

  • 1
    Elasticsearch Java API(九)--删除文档的field以及field的属性
  • 2
    关于百度地图api测距显示NaN的解决方案
  • 3
    linux新的API signalfd、timerfd、eventfd使用说明
  • 4
    1、Windows API函数归总，网络函数、消息函数、文件处理
  • 5
    Google地图官方API- 在地图上绘图（自定义标记）
  • 6
    【ASP.NET Web API教程】2.4 创建Web API的帮助页面
  • 7
    ASP.NET2.0里的web.config配置接口API(转)
  • 8
    FFmpeg开发笔记（五）：ffmpeg解码的基本流程详解（ffmpeg3新解码api）
  • 9
    购物车Demo,前端使用AngularJS,后端使用ASP.NET Web API(2)--前端，以及前后端Session
  • 10
    Asp.Net Web API 2第十七课——Creating an OData Endpoint in ASP.NET Web API 2（OData终结点）
  • 1
    Java 8新特性之Lambda表达式与Stream API的深度解析
    90
  • 2
    Linux系统编程之文件编程常用API回顾和文件编程一般步骤
    74
  • 3
    阿里云微服务引擎及 API 网关 2024 年 4 月产品动态
    383
  • 4
    阿里云微服务引擎 MSE 及 API 网关 2024 年 04 月产品动态
    260
  • 5
    智能体-Agent能力升级！新增Assistant API & Tools API服务接口
    505
  • 6
    使用Performance API进行性能监控
    91
  • 7
    RESTful API的最佳实践
    59
  • 8
    ⚡OWASF 十大 API 安全问题盘点
    240
  • 9
    【JAVA进阶篇教学】第三篇：JDK8中Stream API使用
    59
  • 10
    电商数据集成：利用API接口实现商品详情自动化获取
    112

    • 相关电子书

    更多
  • Spring Boot2.0实战Redis分布式缓存
  • CUDA MATH API
  • API PLAYBOOK

    • 相关实验场景

    更多
  • 基于Assistant Api的旅游助手
  • 快速体验智能体API应用
  • ROS模板参数动态展示
    • 下一篇
    无影云桌面