Description
Downloads a file from SharePoint and adds it to the file store.
Parameters
| Name | Type | Description |
|---|---|---|
| sharepointFileName | String, required | The name of the file to download |
| sharepointFolder | String, required | The folder/folder path in SharePoint the file is in |
| authDetails | Object, optional | The authDetails set in the worker configuration to use. If not set the request will use the default authDetail |
| authDetails.identifier | String | The identifier of authDetails set in the worker configuration |
| authDetails.authType | String | The authType of authDetails set in the worker configuration |
| retrieveMetadata | Boolean, optional | Whether or not to retrieve the metadata |
| filestoreFileName | String, optional | A name for the file when added to the file store. If not supplied the name of the file in SharePoint will be used |
| filestoreApiKey | String, optional | An API Key to access the file store |
Example
{
"id": "123",
"jsonrpc": "2.0",
"method": "sharepointtofilestore",
"params": {
"authDetails": {
"identifier": "GossTest",
"authType": "SAML"
},
"sharepointFileName" : "Test 4k Image.jpg",
"sharepointFolder" : "Shared Documents",
"retrieveMetadata" : true
}
}
Last modified on 25 September 2024
Share this page
