如何使用SharePoint中的REST API在列表中的文件夹中添加项目?

时间:2016-05-13 12:03:59

标签: rest sharepoint directory

以下代码成功添加了列表中的项目,但我想使用REST API在列表中存在的文件夹中添加项目,列表名称为“Designation”,文件夹名称为“Folder1”。我应该在文件夹中插入项目进行哪些更改?

$.ajax({
          url:"https://brillio446.sharepoint.com/teams/Social2016/work/_api/web/lists/getByTitle('Designation')/items", 
          method:"POST",
          dataType:"json",

          data: JSON.stringify({
                                               '__metadata': {'type': 'SP.Data.DesignationListItem' },
                                               'Title': 'D1',

                                            }),

          headers: {
                           "Accept": "application/json;odata=verbose",
                           "content-type": "application/json; odata=verbose",
                           "X-RequestDigest": $("#__REQUESTDIGEST").val(),

                        },
          success: function(data){
                         alert("Item added successfully!");
                        },
          error: function(err){
                            alert("Error while adding item: " + JSON.stringify(err));
                        }
});

我也发现文件夹路径应该在那里,所以我尝试了这段代码...... 但是我得到SP.Data.DesigantionListItem

中不存在“路径”的错误
data: JSON.stringify({
   '__metadata': {'type': 'SP.Data.DesignationListItem' },
   'Title': 'D1',
   'Path': '/ServerRelativeUrl of folder',
}),

2 个答案:

答案 0 :(得分:1)

在创建列表项时似乎不支持指定文件夹URL,但您可以考虑以下方法:

  • 创建ListItem资源
  • 获取关联的 File资源并将其移至文件夹

示例

function executeJson(options) 
{
    var headers = options.headers || {};
    var method = options.method || "GET";
    headers["Accept"] = "application/json;odata=verbose";
    if(options.method == "POST") {
        headers["X-RequestDigest"] = $("#__REQUESTDIGEST").val();
    }   

    var ajaxOptions = 
    {       
       url: options.url,   
       type: method,  
       contentType: "application/json;odata=verbose",
       headers: headers
    };
    if("payload" in options) {
      ajaxOptions.data = JSON.stringify(options.payload);
    }  

    return $.ajax(ajaxOptions);
}



function createListItem(listTitle,properties,folderUrl){
    var url = _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getbytitle('" + listTitle + "')/items";
    return executeJson({
        "url" :url,
        "method": 'POST',
        "payload": properties})
        .then(function(result){
             var url = result.d.__metadata.uri + "?$select=FileDirRef,FileRef";
             return executeJson({url : url});
        })
        .then(function(result){
             var fileUrl = result.d.FileRef;
             var fileDirRef = result.d.FileDirRef;
             var moveFileUrl = fileUrl.replace(fileDirRef,folderUrl);
             var url = _spPageContextInfo.webAbsoluteUrl + "/_api/web/getfilebyserverrelativeurl('" + fileUrl + "')/moveto(newurl='" + moveFileUrl + "',flags=1)";
             console.log(url);
             return executeJson({
                  "url" :url,
                  "method": 'POST',
                  });
        });
}

用法

var listTitle = "Requests";  //list title
var targetFolderUrl = "/Lists/Requests/Archive";  //folder server relative url
var itemProperties = {
    '__metadata': { "type": "SP.Data.RequestsListItem" },
    "Title": 'Request 123'
};


createListItem(listTitle,itemProperties,targetFolderUrl)
.done(function(item)
{
    console.log('List item has been created');
})
.fail(function(error){
    console.log(JSON.stringify(error));
});

Gist

答案 1 :(得分:0)

这是一个古老的问题,但是搜索将我引到了这里,因此为其他人添加了答案。 如Vadim所述,/_api/web/lists/getbytitle('ListTitle')/items方法不支持将项目添加到文件夹。

相反,您应该使用/_api/web/lists/GetByTitle('ListTitle')/AddValidateUpdateItemUsingPath方法。

请务必确保使用字符串值而不是数字或日期或类似字符,因为它的作用与您输入表单相同-解析,验证和保存值。

MSDN参考Create list item in a folder

示例:

$.ajax({
    url:"https://brillio446.sharepoint.com/teams/Social2016/work/_api/web/lists/getByTitle('Designation')/AddValidateUpdateItemUsingPath", 
    method:"POST",
    dataType:"json",
    data: JSON.stringify({{
        "listItemCreateInfo": {
            "FolderPath":  { "DecodedUrl": "/ServerRelativeUrl of folder" },
            "UnderlyingObjectType": 0
        },
        "formValues": [
            {
                "FieldName": "Title",
                "FieldValue": "D1"
            }
        ],
        "bNewDocumentUpdate": false
    }),
    headers: {
        "Accept": "application/json;odata=verbose",
        "content-type": "application/json; odata=verbose",
        "X-RequestDigest": $("#__REQUESTDIGEST").val(),
    },
    success: function(data){
        alert("Item added successfully!");
    },
    error: function(err){
        alert("Error while adding item: " + JSON.stringify(err));
    }
});