SharePoint REST API - 文件夹和文件

最新推荐文章于 2025-04-22 10:37:59 发布
最新推荐文章于 2025-04-22 10:37:59 发布
阅读量2.5k 收藏 6
点赞数 1
分类专栏： SharePoint REST 文章标签： Office 365 SharePoint Online SharePoint REST
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/FoxDave/article/details/71055039
版权

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

本篇讲述如何通过REST操作文件夹和文件。

使用REST操作文件夹

在你知道某个文档库中的文件夹的URL时，可以使用如下的代码获取它。

 

url: http://site url/_api/web/GetFolderByServerRelativeUrl('/Shared Documents')
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

下面的XML是一个请求返回信息的示例。

 

<content type="application/xml">
<m:properties>
<d:ItemCount m:type="Edm.Int32">0</d:ItemCount>
<d:Name>Shared Documents</d:Name>
<d:ServerRelativeUrl>/Shared Documents</d:ServerRelativeUrl>
<d:WelcomePage/>
</m:properties>
</content>

如果想要创建文件夹，使用下面的代码。

 

url: http://site url/_api/web/folders
method: POST
body: { '__metadata': { 'type': 'SP.Folder' }, 'ServerRelativeUrl': '/document library relative url/folder name'}
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

更新文件夹。

 

url: http://site url/_api/web/GetFolderByServerRelativeUrl('/Folder Name')
method: POST
body: { '__metadata': { 'type': 'SP.Folder' }, 'Name': 'New name' }
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/GetFolderByServerRelativeUrl('/Folder Name')
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/GetFolderByServerRelativeUrl('/Folder Name')/Files
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

通过文件名获取指定文件的代码如下。

url: http://site url/_api/web/GetFolderByServerRelativeUrl('/Folder Name')/Files('file name')/$value
method: GET
headers:
    Authorization: "Bearer " + accessToken

或者通过URL。

url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')/$value
method: GET
headers:
    Authorization: "Bearer " + accessToken

下面的示例演示了如何将一个文件添加到指定的文件夹。

url: http://site url/_api/web/GetFolderByServerRelativeUrl('/Folder Name')/Files/add(url='a.txt',overwrite=true)
method: POST
body: "Contents of file"
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    content-length:length of post body

下面展示了如何使用PUT方法（注意对于文件只能用PUT）来更新一个文件。

url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')/$value
method: POST
body: "Contents of file."
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    X-HTTP-Method:"PUT"
    content-length:length of post body

如果你想要更新一个文件的元数据metadata，你需要将文件当做列表项去对待，参考前一讲提到的内容，构建一个如https://<site url>/_api/web/lists/getbytitle('Documents')/items(<item id>)这样的URL去发送请求。

 

如果想要签出一个文件，使用下面的请求。

 

url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')/CheckOut(),
method: POST
headers:
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value

对应的签入操作为。

 

url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')/CheckIn(comment='Comment',checkintype=0)
method: POST
headers:
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value

如果想要删除一个文件，使用下面的请求。

 

url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')
method: POST
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    IF-MATCH: etag or "*"
    X-HTTP-Method:"DELETE"

通过REST操作大文件
通过REST可以操作的最大文件大小为2GB，示例如下。

 

 

url: http://site url/_api/web/GetFolderByServerRelativeUrl('/Folder Name')/Files/Add(url='file name', overwrite=true)
method: POST
body: contents of binary file
headers:
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    content-type: "application/json;odata=verbose"
    content-length:length of post body

下面的代码展示了如何应用上面的请求结合跨域库来实现文件的创建。

 

function uploadFileBinary() {
XDomainTestHelper.clearLog();
var ro;
if (document.getElementById("TxtViaUrl").value.length > 0) {
ro = new SP.RequestExecutor(document.getElementById("TxtWebUrl").value, document.getElementById("TxtViaUrl").value);
}
else {
ro = new SP.RequestExecutor(document.getElementById("TxtWebUrl").value);
}
var body = "";
for (var i = 0; i < 1000; i++) {
var ch = i % 256;
body = body + String.fromCharCode(ch);
}
var info = {
url: "_api/web/lists/getByTitle('Shared Documents')/RootFolder/Files/Add(url='a.dat', overwrite=true)",
method: "POST",
binaryStringRequestBody: true,
body: body,
success: success,
error: fail,
state: "Update"
};
ro.executeAsync(info);
}

通过REST操作列表项的附件

 

下面的请求展示了如何获取指定列表项所有的附件文件。

url: http://site url/_api/web/lists/getbytitle('list title')/items(item id)/AttachmentFiles/
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

也可以通过文件名获取指定的附件。

url: http://site url/_api/web/lists/getbytitle('list title')/items(item id)/AttachmentFiles('file name')/$value
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

如果想向列表项添加附件，使用下面的代码。

url: http://site url/_api/web/lists/getbytitle('list title')/items(item id)/AttachmentFiles/ add(FileName='file name')
method: POST
headers:
    Authorization: "Bearer " + accessToken
    body: "Contents of file."
    X-RequestDigest: form digest value
    content-length:length of post body

如果想更新列表项中的附件，使用下面的代码。

url: http://site url/_api/web/lists/getbytitle('list title')/items(item id)/AttachmentFiles('file name')/$value
method: POST
body: "Contents of file."
headers:
    Authorization: "Bearer " + accessToken
    "X-HTTP-Method":"PUT"
    X-RequestDigest: form digest value
    content-length:length of post body

本文就介绍到这里。

SharePoint REST API - 使用REST API和jQuery上传一个文件
山鹰的专栏
12-21 615
本篇主要通过两个代码示例来展示如何应用REST API和jQuery上传文件到SharePoint。 示例会使用REST接口和jQuery AJAX请求来将一个本地文件添加到SharePoint文档库并修改它的一些属性。主要有以下几个操作步骤： 1. 使用FileReader API将本地文件转换成数组（需要HTML5支持），jQuery的(document).ready函数会检查浏览器对Fi...
SharePoint REST API - 列表和列表项
08-23 3277
博客地址：http://blog.csdn.net/FoxDave 本篇主要讲述如何用SharePoint REST操作列表和列表项。阅读本篇时请先了解前面讲述的REST介绍和基本操作。
【SharePoint】通过SharePoint rest api获取文档库中的文件（排除文件夹，进获取文件）Exclude folder from results in SharePoint api
liuzhenhe1988的专栏
09-26 874
前言 很多时候，需要单独获取SharePoint文档库中的文件（不包含文件夹），如下为实现方式 实现 https://weburl/_api/web/lists/getbytitle('list name')/items?$select=file/Name,file/uniqueid&$expand=File&$filter=FSObjType eq 0&$top=20 https://weburl/_api/web/lists/getbytitle('list nam
powerautomate 使用sharepoint Api获取item用户权限 批量设置权限
最新发布
qq_40777750的博客
04-22 529
powerauto 批量设置sharepoint 权限，获取权限
SharePoint REST API - 概述
weixin_30834019的博客
05-01 321
博客地址：http://blog.csdn.net/FoxDaveSharePoint REST API不同于传统的Server Object Model和Client Object Model，是一种可以直接通过HTTP进行调用的接口。通过它可以直接访问和操作SharePoint的一些数据。如果目前你对REST还一无所知，可以先去简单了解一下。REST服务是...
sharepoint rest api 创建文档库 文件夹
weixin_30553837的博客
06-21 220
创建文档库 //创建文档库文件夹，如文件夹已存在，则覆盖，文件夹里的内容不会受影响 1 function createFolder() 2 { 3 4 var requestHeaders = { 5 "Accept": "application/json;odata=verbose", 6 "X-RequestDigest": $("#__REQUESTDIGE...
SharePoint 2013 Rest and SP.js Copyto and Moveto (Rest 和SP.js 基本用法之 复制和移动文件)
段传涛 的专栏
06-03 1960
SharePoint 2013 Rest Copyto and Moveto code as below:代码原型，到能使用具体还查的远。 executor.executeAsync({ url: "/_api/SP.AppContextSite(@target)/web /getfilebyserverrelativeurl('/Shared Documents/filename
【SharePoint】SharePoint rest api获取文件属性以及其扩展值以及list item总数
liuzhenhe1988的专栏
06-15 888
我们在通过SharePoint rest api获取某个文档库信息的时候，很多时候需要获取文件路径及其文件名，以及其他文件属性，如下通过expand进行相关属性的获取，另外获取list item count的api也会举例说明
SDS：Sharepoint下载计划程序-SDS。 自动下载共享点文件夹
02-26
Sharepoint下载计划程序-SDS 自动下载共享点文件夹。 用法 您可以使用list_site.py扫描list_site.py点站点以下载文件夹。 然后设置您的config.yaml ，然后运行 python ./SDS.py <EMAIL> <PASSWORD>
如何使用 SharePoint REST API 删除文档库中的文件
# 章节一：介绍SharePoint REST API SharePoint是一个流行的协同平台，用于组织、存储和共享文档和数据。它提供了一个功能强大的REST API，使开发人员能够通过编程方式与SharePoint进行交互。 ## 什么是SharePoint...
使用 SharePoint REST API 读取文档库的元数据
# 章节一：介绍SharePoint REST API SharePoint REST API是...SharePoint REST API提供了一组用于操作SharePoint站点、文档库、列表和其他对象的终结点。它遵循HTTP协议，通过HTTP请求和响应进行通信，并采用JSON格式
在 SharePoint 中使用 REST API 更新文档
通过 REST API，开发人员可以使用各种编程语言和平台来对 SharePoint 中的文档、列表、网站等内容进行操作和管理。 ## 1.2 REST API 的优势和用途 SharePoint REST API 提供了灵活、轻量级的方式来与 SharePoint ...
SharePoint REST API 上传文档
天下第一间
03-19 916
　　前言 　　最近，需要用前端代码上传文档到文档库，所有，就有了下面代码。 　　正文 　　读取文件流 var file = document.getElementById("ff").files[0]; var reader = new FileReader(); reader. readAsArrayBuffer(file); reader.onload = function(e){...
SharePoint REST API 获取文件夹下的项目数
天下第一间
10-01 366
　　正文 　　众所周知，SharePoint Online站点有列表数据5000条阈值的限制，而我们每次查询也只能够查询最多5000条数据。当然，这是由于SharePoint对于性能的让步，因为数据库每次查询超过5000条数据会有锁，为了避免这一情况而影响到性能，所以有了这样的限制。 　　但是，我们很多时候需要查询数据列表总数，以前，我们都是先获取到数据表所有项目，再获取Count属性。...
【Sharepoint】如果通过Rest获取SharePoint list或library GUID
liuzhenhe1988的专栏
09-27 255
rest api url: https://weburl/_api/web/lists/getByTitle('products')/Id 结果如下：
SharePoint Rest Api getFileByServerRelativeUrl设置 maxUrlLength
weixin_44225369的博客
12-08 439
今天遇到了这个问题使用的本地版的SharePoint，SharePoint online maxUrlLength据说是改不了。 maxUrlLength默认是260字符，可以将其改成任意大小的整数。 异常状况：有些文件下载报错，文件名也没有特殊符号，查看了SharePoint站点文件路径也确实正确，下载也正常。把请求url放到浏览器返回了错误信息，如下： 通过代码调试，返回了400。 通过图片里的信息有一个 maxUrlLength 。查阅了微软文档 第一次看也挺懵，一顿摸索后解决方法如下： 找到安装
文件和文件夹 REST API 引用
段传涛 的专栏
06-03 3095
文件和文件夹 REST API 引用 转自：https://technet.microsoft.com/zh-cn/subscriptions/index/dn450841.aspx#bk_Overview 适用范围：apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | ShareP
SharePoint 2003 用REST方式访问列表 Filter等高级操作。
段传涛 的专栏
05-30 2851
首先为了方便在chrome 里调试Rest 结果。这里先介绍如URL https://xxx.xxx.com.cn/itc/_api/web/GetFolderByServerRelativeUrl('JSdocs')/files?$filter=Title%20eq%20%27test%27 说明：使用这个句子： https://xxx.xxx.com.cn/itc/_api/web/G
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值