TDV Adapter for Microsoft SharePoint

Build 23.0.8839

UploadDocument

Uploads a document to the SharePoint library.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name Type Description
File String The path of the file to be added.
FileContent String Base64 encoded content of the file to be added. If specified, the value of 'File' input will be ignored.
Library String The URL of the directory you would like to upload file(s) to, relative to the base Url supplied in the adapter's connection properties.

For example:
Root directory: Documents

If you set the Url connection property to a site collection, the relative URL corresponds to a path on the base site.
If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url.
Name String The name assigned to the new file.

If uploading to the root directory of the site, supply only the filename.
If uploading to a folder nested at some level inside the root directory, prepend the full parent subdirectory.

For example:
Root Directory: filename.txt
Sub-directory:MyFolder/filename.txt

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.
Id String The internal Id of the document.
DocumentId String The document Id.
DocumentIdUrl String The URL of the document Id.
FileRef String The file reference of the document.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839