Error when updating a document properties using REST API

Question

I need to update the version number of a document in a document library in SharePoint Online. I used postman to test this. Here is the POST Request I used.

https://MySharePointServer/sites/MySite/_api/web/getfilebyserverrelativeurl('/sites/MySite/JobApplications/Application001.docx')/ListItemAllFields

Request Headers

Accept          : application/json;odata=verbose
Authorization   : 'My Authorization Code Here'
X-HTTP-Method   : MERGE
If-Match        : *
Content-Type    : application/json;odata=verbose
X-RequestDigest : 'MyRequestDigestCodeHere'

Request Body

{ '__metadata': { 'type': 'SP.Data.JobApplicationsItem' }, 'OData__UIVersionString': '4.0' }

But when I send this request I always get the following response.

{
"error": {
"code": "-2147024891, System.UnauthorizedAccessException",
"message": {
  "lang": "en-US",
  "value": "Access denied. You do not have permission to perform this action or access this resource."
  }
 }
}

Do you have any idea what I'm doing wrong here? Any suggestions would be highly appreciated.

Sorry, I missed it in my question. I already added that in my request. — Jake
– Jake, Commented Dec 30, 2015 at 12:52
SharePoint usually assigns the version number to the item on the server when you update it, why are you trying to manually assign it? — John-M
– John-M, Commented Dec 30, 2015 at 13:51

Per Jakobsen · Accepted Answer · 2015-12-30 14:58:09Z

5

You can't update the Version number directly.

To make a major version you have to use the CheckIn method with checkInType=1.

Or depending on your list Publish+Approve

answered Dec 30, 2015 at 14:58

Per Jakobsen

32.4k1 gold badge35 silver badges62 bronze badges

'/approve' just updated the minor version to the next major version which was exactly what I was searching for..! Thank you very much.

Jake
– Jake

2015-12-30 17:11:35 +00:00
Commented Dec 30, 2015 at 17:11

Add a comment |

John-M · Accepted Answer · 2015-12-30 15:00:52Z

You can't set the version number manually (even with the server object model you can only 'get' the version property, no setter identified); just doing a major version check-in should accomplish what you're looking for and let SharePoint figure out what version number to provide though:

function majorCheckInAsync(fileUrl, comment) {
    var dfd = $.Deferred();

    $.ajax({
        url: "/_api/web/GetFileByServerRelativeUrl('" + fileUrl + "')/CheckOut()",
        type: "POST",
        headers:  {
            "accept": "application/json;odata=verbose",
            "content-type": "application/json;odata=verbose",
            "X-RequestDigest": $("#__REQUESTDIGEST").val()
        }
    }).fail(failHandler).then(function() {
        $.ajax({
            url: "/_api/web/GetFileByServerRelativeUrl('" + fileUrl + "')/CheckIn(comment='" + comment +"', checkintype=1)",
            type: "POST",
            headers:  {
                "accept": "application/json;odata=verbose",
                "content-type": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").val()
            }
        }).fail(failHandler).then(function(data) {
            dfd.resolve(data);
        });
    });

    return dfd.promise();

    function failHandler(jqXHR, textStatus, errorThrown) {
            dfd.reject(jqXHR, textStatus, errorThrown);
    }
}

Call this with something like:

majorCheckInAsync("/Shared%20Documents/my%20new%20file.txt", "Checkin from REST")
    .then(function(data) { console.log("item checked in") });

Note the checkintype in my REST url is set to 1 -- this corresponds to a MajorCheckIn in the SP.CheckInType enumeration:

checkInType

Type: Int32

The SP.CheckinType for the file: MinorCheckIn = 0; MajorCheckIn = 1; OverwriteCheckIn = 2.

Doing a major check in is what will give us the x.0 major version number.

Thanks for your answer John. I tried your approach. But the document should be in 'checked-out' before we do this. — Jake
– Jake, Commented Dec 30, 2015 at 16:42
@JanakaLP if the document is already checked out you can just skip the CheckOut endpoint call and proceed directly to CheckIn, the technique would still be the same - and I realize now you didn't even ask in the context of JavaScript but the approach should be similar — John-M
– John-M, Commented Dec 30, 2015 at 16:53
Thank you very much John. Just replaced the '/CheckIn' in the end of the URL with '/Approve' and it updated the minor version to the next major version successfully..! Thanks again. — Jake
– Jake, Commented Dec 30, 2015 at 17:03

Stack Exchange Network

Error when updating a document properties using REST API

2 Answers 2

Your Answer

Hot Network Questions

Error when updating a document properties using REST API

2 Answers 2

Your Answer

Sign up or log in

Post as a guest

Related

Hot Network Questions