{"id":362,"date":"2023-11-29T15:13:29","date_gmt":"2023-11-29T14:13:29","guid":{"rendered":"https:\/\/france.magicsoftware.com\/blog\/?p=362"},"modified":"2025-03-13T17:42:32","modified_gmt":"2025-03-13T16:42:32","slug":"sharepoint-online-magic-xpi","status":"publish","type":"post","link":"https:\/\/france.magicsoftware.com\/blog\/magic-xpi\/sharepoint-online-magic-xpi\/","title":{"rendered":"SharePoint Online – Magic xpi: How to Get the Content list of a SharePoint folder and download files locally using REST Sharepoint API"},"content":{"rendered":"\n

Describe the different steps for connecting Magic xpi with SharepointOnline using REST Sharepoint API (*)<\/p>\n\n\n\n

(*) Sharepoint can be accessed also via REST Microsoft Graph API (not described in this post)<\/p>\n\n\n\n

Goal<\/strong> : Download files from Sharepoint Online Folder<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
1\/ Check that you can call REST Sharepoint Online API using Postman with your credentials<\/pre>\n\n\n\n
Send a POST on https:\/\/accounts.accesscontrol.windows.net\/<yourtenantid>\/tokens\/OAuth\/2<\/strong> by passing grant_type, client_id, client_secret, resource in other to get the token<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Send a GET on https:\/\/<YourSharePointCollectionURL><\/em><\/strong>.sharepoint.com\/sites\/<SPsite><\/strong>\/_api\/web\/GetFolderByServerRelativeUrl(‘\/sites\/<SPsite><\/strong>\/<subfolder1><\/strong>\/<subfolder2><\/strong>\/’)\/files  <\/p>\n\n\n\n
For example in my case :<\/p>\n\n\n\n
https:\/\/<YourSharePointCollectionURL><\/em><\/strong>.sharepoint.com\/sites\/MSE-France<\/strong>\/_api\/web\/GetFolderByServerRelativeUrl(‘\/sites\/MSE-France<\/strong>\/SaadLibrary2\/test2\/’)\/files   to check that you can retrieve all the information related to folder content.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
(*) client_id, client_secret, tenantid and resource can be generated using these steps below<\/p>\n\n\n\n
1.1 Navigate to : https:\/\/<YourSharePointCollectionURL>\/_layouts\/15\/appregnew.aspx<\/strong><\/em> to register a new Sharepoint app<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
1.2 after generating client id and client secret, navigate to :<\/p>\n\n\n\n
https:\/\/<YourSharePointCollectionURL><\/em>\/_layouts\/15\/appinv.aspx<\/strong> to grant permission to your app<\/p>\n\n\n\n
fill the information and copy\/paste the xml below in the field Apps permission request XML<\/p>\n\n\n\n
<AppPermissionRequests AllowAppOnlyPolicy=\u00a0\u00bbtrue\u00a0\u00bb> <AppPermissionRequest Scope=\u00a0\u00bbhttp:\/\/sharepoint\/content\/sitecollection\/web<\/a>\u00a0\u00bb Right=\u00a0\u00bbFullControl\u00a0\u00bb \/> <\/AppPermissionRequests><\/p>\n\n\n\n
1.3 Navigate to : https:\/\/<YourSharePointCollectionURL><\/em>\/_layouts\/15\/appprincipals.aspx<\/strong> to get the tenantid and clientid with @<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
2\/ Create a New Magic xpi Flow with a Flow Data Step first and update a variable with the body credentials<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
3\/ Create a REST Client Magic xpi resource to navigate to https:\/\/accounts.accesscontrol.windows.net<\/strong> to get the Bearer token (Project=>Settings=>Resources)<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
4\/ Use REST Client Connector to call the previous URL<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
5\/ Parse the json response to get the token using a Flow Data Component<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You will use the variable C.AccessToken later on in the Authorization Header parameter<\/p>\n\n\n\n
6\/ Create a REST Client Magic xpi resource to call sharepoint methods (Project=>Settings=>Resources)<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
7\/ Drag and Drop a REST Client Connector linked to the previous resource and configure the connector to set the path {List}<\/strong> with Get operation.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Enter the value : ‘Bearer ‘&trim(c.AccessToken)  for the Authorization in the Header Parameters<\/p>\n\n\n\n
8\/ Update list<\/strong> parameter with the expression : ‘GetFolderByServerRelativeUrl(\u00a0\u00bb<FolderPath>\u00a0\u00bb)\/files<\/strong>‘<\/p>\n\n\n\n
example : GetFolderByServerRelativeUrl(\u00a0\u00bb\/sites\/MSE-France\/SaadLibrary2\/test2\u00a0\u00bb)\/files<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
9\/ Drag and Drop a Datamapper component to parse the result and make a loop to call another flow that will responsible to download the file<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Set F.FileName and F.RelativeURL variables with Name and ServerRelativeURL.<\/p>\n\n\n\n
10\/ Create another path in the resource repository {monpath}<\/strong><\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
11\/ Drag & Drop a REST Client connector and right click to configure the connector<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Set monpath<\/strong> parameter with the expression : ‘GetFolderByServerRelativeUrl(\u00a0\u00bb’&Trim (F.RelativeURL)&\u00a0\u00bb’)\/Files(\u00a0\u00bb’&Trim (F.FileName)&\u00a0\u00bb’)\/$Value<\/strong>‘<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
12\/ Drag & Drop a FileManagement component to save the file on the disk<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
13\/ If the previous step \u00ab\u00a0Get File\u00a0\u00bb is successfull then delete the file on sharepoint folder<\/p>\n\n\n\n
Create another path in the resource repository {delete}<\/strong><\/p>\n\n\n\n
Don’t forget to set in the header : X-HTTP-Method to DELETE<\/strong><\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
14\/ Drag & Drop a REST Client connector to call the delete method at the end of the flow<\/p>\n\n\n\n
Choose a Post operation<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Update the parameter delete<\/strong> with the expression : ‘GetFolderByServerRelativeUrl(\u00a0\u00bb’&Trim (F.RelativeURL)&\u00a0\u00bb’)\/Files(\u00a0\u00bb’&Trim (F.FileName)&\u00a0\u00bb’)’<\/strong><\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
15\/ Document reference : https:\/\/www.c-sharpcorner.com\/article\/how-to-test-sharepoint-online-rest-apis-using-postman-tool\/<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Describe the different steps for connecting Magic xpi with SharepointOnline using REST Sharepoint API (*) (*) Sharepoint can be accessed also via REST Microsoft Graph API (not described in this post) Goal : Download files from Sharepoint Online Folder 1\/ Check that you can call REST Sharepoint Online API using Postman with your credentials Send […]<\/p>\n","protected":false},"author":1,"featured_media":858,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[4,28,26],"tags":[14,23,13],"class_list":["post-362","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-magic-xpi","category-microsoft","category-sharepoint","tag-magic-xpi","tag-rest","tag-sharepoint"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t