SharePoint 365 Rest API: Add a link item in a document library

Question

Hi&nbsp;I am looking into creating a new link item&nbsp;in a document library using rest api. I have looked around and can not find a solution as yet.&nbsp;Has anyone managed to achieve this?&nbsp;Many thanks&nbsp;Iain&nbsp;&nbsp;&nbsp;

toby statham · Answer

iainmac&nbsp;You need to upload a text file with an extension of .url and it contents as follows&nbsp;&nbsp;[InternetShortcut]URL = https://yourlink&nbsp;and then set the the files corresponding List Item "_ShortcutUrl" field to a FieldUrlValue of the link and the filename.&nbsp;Have done this with CSOM, so should be able to do something similar through the REST API

augustgeier · Answer

I was able to do this via the MS Graph API. For those that this may help:

MS Graph API version: 1.0
Method: PUT
URL: https://graph.microsoft.com/v1.0/sites/{site_id}/drive/root:/name of link that can contain spaces.url:/content
Request Headers: content-type text/plain
Request Body (separate lines are important here):
[InternetShortcut]
URL=https://some.website.com/path/more_path

carlos_marins · Answer

Hey&nbsp;iainmac,&nbsp;That's a good question. I was looking through the PnP REST library and it doesn't seem like there is a way to do it from there. Maybe because Links in document libraries are not commonly used.One thing I noticed, though, is if you open the Dev tools(F12 on Chrome) and watch the Network tab, when you add a link to a library, looks like this is the REST call adding it:&nbsp;https://&lt;tenant&gt;.sharepoint.com/sites/&lt;siteName&gt;/_api/web/GetFolderByServerRelativeUrl(@a1)/Files/AddUsingPath(decodedUrl=@a2,overwrite=@a3)?@a1="&lt;libraryRelativePath&gt;"&amp;@a2="&lt;linkName&gt;"&amp;@a3=false&nbsp;This is a POST request, and the payload is "Url=&lt;fileLink&gt;". Keep in mind that the libraryPath in the URL is relative, starting with "/sites/...", while the fileLink is absolute, starting with "https://..."&nbsp;I didn't test it manually, but you can try using AJAX to see it the call works. I attached a print of the call in Chrome Dev Tools, blurring some sensitive info. As you can notice in the payload, the link is to the file "myDoc.docs"(oops, typo) which is the folder 'pasta' of the Shared Documents library.&nbsp;If you need any help, let me know.&nbsp;&nbsp;

iainmac · Answer

Thanks&nbsp;Carlos_Marins&nbsp;&nbsp;I have managed to build on your reply to create a successful url link in a document library&nbsp;Here is the Js code I used, not the cleanest of code - but it works for me.&nbsp;function AddLink() {&nbsp;&nbsp;&nbsp;&nbsp; var Uri = "http://www.google.com" + ".url";&nbsp;&nbsp;&nbsp; var library = "/documents"&nbsp;&nbsp;&nbsp;&nbsp; var resUri&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = encodeURIComponent(Uri).replace(/\./g, '%2E');&nbsp;&nbsp;&nbsp; var reslibrary&nbsp; = encodeURIComponent(library).replace(/\./g, '%2E');&nbsp;&nbsp;&nbsp;&nbsp; var AddLinkURL = _spPageContextInfo.webAbsoluteUrl + "/_api/web/GetFolderByServerRelativeUrl(@a1)/Files/AddUsingPath"&nbsp;&nbsp;&nbsp;&nbsp; AddLinkURL +=&nbsp; "(decodedUrl=@a2,overwrite=@a3)?";&nbsp;&nbsp;&nbsp; AddLinkURL += "@a1=%27" + reslibrary + "%27&amp;";&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // Library&nbsp;&nbsp;&nbsp; AddLinkURL += "@a2=%27" + resUri + "%27&amp;";&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // File&nbsp;&nbsp;&nbsp; AddLinkURL += "@a3=false";&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // overwrite&nbsp;&nbsp;&nbsp;&nbsp; console.log(AddLinkURL);&nbsp;&nbsp;&nbsp; $.ajax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ({&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; url: AddLinkURL,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; type: "POST",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; processData: false,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; async: false,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; headers: {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "accept": "application/json;odata=verbose",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "X-RequestDigest": jQuery("#__REQUESTDIGEST").val(),&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; },&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; success: function (data) {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; console.log("Item Inserted..!!");&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; console.log(data);&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; },&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; error: function (data) {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; console.log("API Error");&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; console.log(data);&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; }&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; });&nbsp;&nbsp;}​Thanks for your help&nbsp;Iainmac&nbsp;&nbsp;

carlos_marins · Answer

Great! Glad to know I could help! I might even save your code for reference.Don't forget to mark the post as solved.Regards

Forum Discussion

SharePoint 365 Rest API: Add a link item in a document library

8 Replies

Resources