GET getFileContentByPath

Method Description	This function allows you to get a file from SharePoint and returns its contents in a format called Base64, which is often used to safely store or send files as text.
Returns	Directory Item
Limitations	File size capacity is limited to files 10MB or smaller
Usage	For notes on how to authenticate see NetSuite documentation. General usage notes see: File Sync REST API
Since	FileSync 0.6.0

Request Parameters

Parameter	Type	Required	Description	Since
`options.action`	string	required	Static value that has to equal getFileContentByPath	0.6.0
`options.script`	string	required	Static value that has to equal customscript_b4cd_fileapi_rl	0.6.0
`options.deploy`	string	required	Static value that has to equal customdeploy_b4cd_fileapi_rl	0.6.0
options.filePath	string	required	The path of the file for which the content is being requested. This value is generally retrieved by making a call to the getRecordFolderContents method.	0.6.0
options.recordTypeConfigId	integer	required	Internal ID of the FileSync Record Type Configuration record (customrecord_b4cd_record_type_config).	0.6.0

Returns

Property	Type	Description	Since
`DirectoryItem.name`	string	The file or folder name	0.6.0
`DirectoryItem.uniqueId`	string	The unique ID of the file or folder as assigned by the file hosting service.	0.6.0
`DirectoryItem.type`	string	Possible Values: "file", "folder"	0.6.0
`DirectoryItem.fileSize`	integer	File size in bytes.	0.6.0
`DirectoryItem.apiUri`	string	The URI used to access the file or folder via the API.	0.6.0
`DirectoryItem.filePath`	string	The relative file or folder path on the file hosting service starting from the base directory.	0.6.0
`DirectoryItem.uri`	string	The user-navigable URI for the folder or file on the file hosting platform. This can be used to construct hyperlinks for users to reach the file or folder externally.	0.6.0
`DirectoryItem.fileContent`	string	File contents as encoded Base64 content	0.6.0

Errors

Error Code	Details
`SSS_MISSING_REQD_ARGUMENT`	A required argument is missing or undefined.

Request Query Parameters Example

{
    script: "customscript_b4cd_fileapi_rl",
    deploy: "customdeploy_b4cd_fileapi_rl",
    action: "getFileContentById",
    filePath: "/sites/FilesConnectorSite/Shared Documents/Vendor Bill/20703/postmanFolder/Bill_1000234.pdf",
    recordTypeConfigId: 3
}

Was this article helpful?