Endpoint Get Item (File or Folder)
Name
get_item
Description
Related Tables
Parameters
Parameter | Required | Options | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name:
Label: Drive Id / Shared Folder Specify a drive |
YES | |||||||||||||||
Name:
Label: File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed Specify a File/Folder Id or Path (e.g. root:/myfolder/file.xyz: ) |
YES | |||||||||||||||
Name:
Label: Default Group or User Id (additional Scopes needed to list - If fails enter manually) 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} |
|
|||||||||||||||
Name:
Label: Search Type (For UI Only - Default=Recursive - i.e. Blank) If you do not wish to see files from child folders then use Non-Recursive option. Recursive option has certain limitations (e.g. Only indexed files will appear so it takes time to show up in the list). If you do not see some files listed in the output then use Non-Recursive option (must specify Parent Folder Path in SearchPath property). |
|
|||||||||||||||
Name:
Label: Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder). |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
id |
DT_WSTR
|
nvarchar(500)
|
500 | |
name |
DT_WSTR
|
nvarchar(150)
|
150 | |
size |
DT_I8
|
bigint
|
||
createdDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
lastModifiedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
webUrl |
DT_WSTR
|
nvarchar(1500)
|
1500 | |
webUrlPath |
DT_WSTR
|
nvarchar(1500)
|
1500 | |
createdBy_user_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
createdBy_user_email |
DT_WSTR
|
nvarchar(150)
|
150 | |
createdBy_user_displayName |
DT_WSTR
|
nvarchar(100)
|
100 | |
createdBy_application_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
createdBy_application_displayName |
DT_WSTR
|
nvarchar(100)
|
100 | |
lastModifiedBy_user_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
lastModifiedBy_user_email |
DT_WSTR
|
nvarchar(150)
|
150 | |
lastModifiedBy_user_displayName |
DT_WSTR
|
nvarchar(150)
|
150 | |
lastModifiedBy_application_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
lastModifiedBy_application_displayName |
DT_WSTR
|
nvarchar(150)
|
150 | |
parentReference_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
parentReference_driveId |
DT_WSTR
|
nvarchar(400)
|
400 | |
parentReference_driveType |
DT_WSTR
|
nvarchar(100)
|
100 | |
parentReference_name |
DT_WSTR
|
nvarchar(200)
|
200 | 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 | |
parentReference_path |
DT_WSTR
|
nvarchar(1000)
|
1000 | 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
|
||
fileSystemInfo_lastModifiedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
folder_childCount |
DT_I8
|
bigint
|
||
file_mimeType |
DT_WSTR
|
nvarchar(300)
|
300 | |
file_quickXorHash |
DT_WSTR
|
nvarchar(200)
|
200 | |
file_sha1Hash |
DT_WSTR
|
nvarchar(200)
|
200 | |
file_sha256Hash |
DT_WSTR
|
nvarchar(200)
|
200 | |
shared_scope |
DT_WSTR
|
nvarchar(100)
|
100 | |
remoteItem_parentReference_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_parentReference_driveId |
DT_WSTR
|
nvarchar(400)
|
400 | |
remoteItem_parentReference_driveType |
DT_WSTR
|
nvarchar(100)
|
100 | |
remoteItem_parentReference_name |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_parentReference_siteId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_parentReference_path |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
remoteItem_shared_scope |
DT_WSTR
|
nvarchar(100)
|
100 | |
remoteItem_shared_sharedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
remoteItem_sharedBy_user_id |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharedBy_user_email |
DT_WSTR
|
nvarchar(150)
|
150 | |
remoteItem_sharedBy_user_displayName |
DT_WSTR
|
nvarchar(150)
|
150 | |
remoteItem_sharepointIds_listId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_listItemId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_listItemUniqueId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_siteId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_siteUrl |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_tenantId |
DT_WSTR
|
nvarchar(200)
|
200 | |
remoteItem_sharepointIds_webId |
DT_WSTR
|
nvarchar(200)
|
200 | |
id_path |
DT_WSTR
|
nvarchar(200)
|
200 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Examples
SSIS
Use OneDrive Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Files table, therefore it is better to use it, instead of accessing the endpoint directly:
Required Parameters | |
---|---|
Drive Id / Shared Folder | Fill-in the parameter... |
File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed | Fill-in the parameter... |
Optional Parameters | |
Default Group or User Id (additional Scopes needed to list - If fails enter manually) | |
Search Type (For UI Only - Default=Recursive - i.e. Blank) | |
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed |

API Destination
This Endpoint belongs to the Files table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get item:
Required Parameters | |
---|---|
Drive Id / Shared Folder | Fill-in the parameter... |
File/Folder Id or Path (e.g. root:/myfolder: -OR- root:/myfolder/file.xyz: ) - Max 1000 Listed | Fill-in the parameter... |
Optional Parameters | |
Default Group or User Id (additional Scopes needed to list - If fails enter manually) | |
Search Type (For UI Only - Default=Recursive - i.e. Blank) | |
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed |

ODBC application
Use these SQL queries in your ODBC application data source:
Get item
SELECT * FROM Files
WHERE Id = 'abcd-1234-itemid'
WITH
(
"DriveId" = 'abcd-1234-driveid'
)
get_item
endpoint belongs to
Files
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get item
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Files
WHERE Id = ''abcd-1234-itemid''
WITH
(
"DriveId" = ''abcd-1234-driveid''
)';
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];
get_item
endpoint belongs to
Files
table(s), and can therefore be used via those table(s).