EndPoint Upload File

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

upload_file

Description

Upload a file to the specified path [API reference]

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id / Shared Folder

YES

Specify a drive

SourceFilePath

Disk File Path (e.g. c:\somefolder\file.xlsx)

YES

Specify a disk file path

TargetFilePath

Target File Path / Id (e.g. file.xlsx -OR- myfolder/file.xlsx -OR- 0Zxxxx1234)

YES

Option	Value
Example #1 (Save On Root)	file.xlsx
Example #2 (Save Under Folder)	myfolder/myfile.xlsx
Example #3 (Save Under Child Folder)	myfolder/subfolder/myfile.xlsx
Example #4 (Overwrite Exising File by ID)	0Zxxxx1234

Specify Target file path or exising file Id (for Overwrite scenario)

ConflictBehavior

Conflict Behavior (What to do if file exists)

YES

Option	Value
fail	fail
replace	replace
rename	rename

GroupOrUserId

Default Group or User Id (additional Scopes needed to list - If fails enter manually)

Option	Value
My self (Not Valid for Application Credentials)
For any group	/groups/ENTER-GROUP-EMAIL-OR-ID
For any user	/users/ENTER-USER-EMAIL-OR-ID

To list all users and groups from your organizations you need additional scopes. See connection UI - Choose User.Read.All and Group.Read.All Scopes and regenerate token. You can manually type value too if you know Group or User Id. Format is /users/{id} OR /groups/{id}

UseSourceFileTimeStamp

Use Source File Created/Modified DateTime rather than Uploaded Time

Option	Value
Use Uploaded Time (Blank)
Use Source File Time	true

Set this property if you like to set file creation/modified date as original file. By default its set to uploaded date/time. This may not be desired if file was actually created on different date than uploaded. If you do not set then current date/time used (Upload time).

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
id	`DT_WSTR`	`nvarchar(500)`	500	False
name	`DT_WSTR`	`nvarchar(150)`	150	False
size	`DT_I8`	`bigint`		False
createdDateTime	`DT_DBTIMESTAMP`	`datetime`		False
lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		False
webUrl	`DT_WSTR`	`nvarchar(1500)`	1500	False
webUrlPath	`DT_WSTR`	`nvarchar(1500)`	1500	False
createdBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	False
createdBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	False
createdBy_user_displayName	`DT_WSTR`	`nvarchar(100)`	100	False
createdBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	False
createdBy_application_displayName	`DT_WSTR`	`nvarchar(100)`	100	False
lastModifiedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	False
lastModifiedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	False
lastModifiedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	False
lastModifiedBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	False
lastModifiedBy_application_displayName	`DT_WSTR`	`nvarchar(150)`	150	False
parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	False
parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	False
parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	False
parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	False	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	False
parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	False	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
fileSystemInfo_createdDateTime	`DT_DBTIMESTAMP`	`datetime`		False
fileSystemInfo_lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		False
folder_childCount	`DT_I8`	`bigint`		False
file_mimeType	`DT_WSTR`	`nvarchar(300)`	300	False
file_quickXorHash	`DT_WSTR`	`nvarchar(200)`	200	False
file_sha1Hash	`DT_WSTR`	`nvarchar(200)`	200	False
file_sha256Hash	`DT_WSTR`	`nvarchar(200)`	200	False
shared_scope	`DT_WSTR`	`nvarchar(100)`	100	False
remoteItem_parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	False
remoteItem_parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	False
remoteItem_parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	False
remoteItem_shared_scope	`DT_WSTR`	`nvarchar(100)`	100	False
remoteItem_shared_sharedDateTime	`DT_DBTIMESTAMP`	`datetime`		False
remoteItem_sharedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	False
remoteItem_sharedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	False
remoteItem_sharepointIds_listId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_listItemId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_listItemUniqueId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_siteId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_siteUrl	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_tenantId	`DT_WSTR`	`nvarchar(200)`	200	False
remoteItem_sharepointIds_webId	`DT_WSTR`	`nvarchar(200)`	200	False
id_path	`DT_WSTR`	`nvarchar(200)`	200	False

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.