POST offloadFileById

Method Description	This function allows you to offload a file from NetSuite to SharePoint.
Returns	Directory Item
Limitations	Non-Text files: 10MB Text files: 400MB
Usage	For notes on how to authenticate see NetSuite documentation. General usage notes see: File Sync REST API
Since	FileSync 0.6.0

Parameter	Type	Required	Description	Since
`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

Note: The options parameter is a JavaScript object.

Parameter	Type	Required	Description	Since
`options.action`	string	required	Value must equal "offloadFileById" This value represents the method that is called.	0.6.0
`options.recordId`	integer	required	The internal ID of the record in NetSuite which we are associating the new file to.	0.6.0
`options.fileId`	integer	required	The internal ID of the file(s) being offloaded from Netsuite	0.6.0
`options.recordTypeConfigId`	integer	required	Internal ID of the FileSync Record Type Configuration record (customrecord_b4cd_record_type_config).	0.6.0

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

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

{
    "recordId":"203344",
    "fileId": 306306,
    "recordTypeConfigId":3,
    "action":"offloadFileById"
}

Was this article helpful?