Toggle menu

filestoreToSharepoint

Description

Takes a file from the file store and uploads it to SharePoint.

The metadata parameter contains the metadata you want to add to SharePoint. Only metadata columns that already exist in SharePoint can be added.

Parameters

NameTypeDescription
filestoreIdString, requiredThe UUID of the file in the filestore to upload
sharepointFolderString, requiredThe folder/folder path in SharePoint to upload to
authDetailsObject, optionalThe authDetails set in the worker configuration to use. If not set the request will use the default authDetails
authDetails.identifierStringThe identifier of authDetails set in the worker configuration
authDetails.authTypeStringThe authType of authDetails set in the worker configuration
metadataObject, optionalKey/value pairs for the metadata you want to add to the file in SharePoint
overwriteBoolean, optionalDefault: true. Whether or not you want to overwrite a file that already exists. If this property is set as false and the file already exists in SharePoint, an error will be thrown
fileNameString, optionalA name for the file when added. If not supplied the file name in the filestore will be used
filestoreApiKeyString, optionalAn API key to access the filestore

Example

{
    "id": "123",
    "jsonrpc": "2.0",
    "method": "filestoreToSharepoint",
    "params": {
        "authDetails": {
            "identifier": "GossTest",
            "authType": "SAML"
        },
        "filestoreId": "fe7bfe91-a4f1-446f-8678-0dc8657f0a64",
        "sharepointFolder": "Shared Documents",
        "metadata": {
            "Title": "An example word doc",
            "Year": "1066",
            "Note": "Upload test to test searching"
        }  
    }
}

Last modified on September 25, 2024

Share this page

Facebook icon Twitter icon email icon

Print

print icon