POST createFolderByPath

Method Description	This function allows you to create a new file in SharePoint.
Returns	Directory Item
Limitations	None
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.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

Request Body

Note: The options parameter is a JavaScript object.

Parameter	Type	Required	Description	Since
`options.action`	string	required	Value must equal "createFolderByPath" This value represents the method that is called.	0.6.0
`options.folderName`	string	required	The name of the new Folder which we are creating.	0.6.0
`options.parentFolderPath`	string	required	The path of the parent-folder for which the new folder will be created under. This value is generally retrieved by making a call to the getRecordFolderContents or the getFolderContentsById 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 Directory Item

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
DirectoryItem.parentFolderName	string	If `options.includeSubfolders` is true this value will return the parent folder name of the directory item.	0.6.0
DirectoryItem.parentFolderUniqueId	string	If `options.includeSubfolders` is true this value will return the parent folder unique ID of the directory item.	0.6.0

Errors

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

Example Request Body

{
    "folderName":"postmanFolder",
    "parentFolderPath": "/sites/FilesConnectorSite/Shared Documents/Vendor Bill/20703",
    "recordTypeConfigId":3,
    "action":"createFolderByPath"
}

Was this article helpful?