Reference

Endpoint Read JSON File (Generic)

Name

get_json_file

Description

No description available

Related Tables

JSON File Read/Write

Parameters

Parameter Required Options
Name: DriveId

Label: Drive Id

Specify a drive 		YES
Name: FileId

Label: File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed

Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: ) 		YES
Name: SiteId

Label: Site Id (Re-Select Drive Id after you change this)

Specify a site
Name: SearchType

Label: Search Type - For UI Only (i.e. Recursive -OR- Non-Recursive) - Default=Recursive)

NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. 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).
Option Value
Recursive All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope
Non-Recursive / Children All Files (Only for Non-Shared Items) children
Recursive All - For User Creds Only search(q='')
Recursive *.xlsx Files - For User Creds Only search(q='.xls')
Recursive *.csv Files - For User Creds Only search(q='.csv')
Recursive *.json Files - For User Creds Only search(q='.json')
Recursive Custom Extension Files - For User Creds Only search(q='.myext')
Name: SearchPath

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
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing SharePoint Online Connector.

Input Columns

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

Examples

SSIS

Use SharePoint Online Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the JSON File Read/Write table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - SharePoint Online
SharePoint Connector can be used to read, write data in SharePoint Online List / Document Library, perform file operations such as upload, download, create, move, delete, rename in a few clicks!
SharePoint Online
JSON File Read/Write
Required Parameters
Drive Id Fill-in the parameter...
File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Fill-in the parameter...
FileCompressionType Fill-in the parameter...
Optional Parameters
Site Id (Re-Select Drive Id after you change this)
Search Type - For UI Only (i.e. Recursive -OR- Non-Recursive) - Default=Recursive)
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
DataFormat Notset
Continue On 404 Error (When item not found) True
Filter
ExcludedProperties
Encoding
CharacterSet
EnableCustomReplace
SearchFor
ReplaceWith
EnableArrayFlattening
MaxArrayItemsToFlatten
ArrayTransformType
ArrayTransColumnNameFilter
ArrayTransRowValueFilter
ArrayTransEnableCustomColumns
ArrayTransCustomColumns
EnablePivot
DateFormatString
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the JSON File Read/Write table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read json file:

API Destination - SharePoint Online
SharePoint Connector can be used to read, write data in SharePoint Online List / Document Library, perform file operations such as upload, download, create, move, delete, rename in a few clicks!
SharePoint Online
JSON File Read/Write
Select
Required Parameters
Drive Id Fill-in the parameter...
File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed Fill-in the parameter...
FileCompressionType Fill-in the parameter...
Optional Parameters
Site Id (Re-Select Drive Id after you change this)
Search Type - For UI Only (i.e. Recursive -OR- Non-Recursive) - Default=Recursive)
Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed
DataFormat Notset
Continue On 404 Error (When item not found) True
Filter
ExcludedProperties
Encoding
CharacterSet
EnableCustomReplace
SearchFor
ReplaceWith
EnableArrayFlattening
MaxArrayItemsToFlatten
ArrayTransformType
ArrayTransColumnNameFilter
ArrayTransRowValueFilter
ArrayTransEnableCustomColumns
ArrayTransCustomColumns
EnablePivot
DateFormatString
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read JSON File from SharePoint Document Library (Parse Rows and Columns without downloading)

This example shows how to read a JSON file from SharePoint Document Library without downloading on Disk (Streaming approach). 

SELECT * from get_json_file 
WITH(
	  DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0'
	, FileId='root:/MyFolder/dump.json:'
  , Filter='$.store.books[*]' --or just blank (see help file for more filter examples)
  --to read compressed file use below way
	--, FileId='root:/MyFolder/dump.json.gz:'
	--, FileCompressionType='GZip' --None, GZip, Zip
)

Read Zip/Gzip Compressed JSON File from SharePoint Document Library (Parse Rows and Columns without downloading)

This example shows how to read a compressed JSON file (Zip or Gzip) from SharePoint Document Library without downloading on the Disk (Streaming approach). 

SELECT * from get_json_file
WITH(
	  DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0'
	, FileId='root:/MyFolder/dump.json.zip:'
  , Filter='$.store.books[*]' --or just blank (see help file for more filter examples)
  , FileCompressionType='Zip' --None, GZip, Zip
)

get_json_file endpoint belongs to FileReaderWriterJson 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:

Read JSON File from SharePoint Document Library (Parse Rows and Columns without downloading)

This example shows how to read a JSON file from SharePoint Document Library without downloading on Disk (Streaming approach). 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from get_json_file 
WITH(
	  DriveId=''b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0''
	, FileId=''root:/MyFolder/dump.json:''
  , Filter=''$.store.books[*]'' --or just blank (see help file for more filter examples)
  --to read compressed file use below way
	--, FileId=''root:/MyFolder/dump.json.gz:''
	--, FileCompressionType=''GZip'' --None, GZip, Zip
)';

EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];

Read Zip/Gzip Compressed JSON File from SharePoint Document Library (Parse Rows and Columns without downloading)

This example shows how to read a compressed JSON file (Zip or Gzip) from SharePoint Document Library without downloading on the Disk (Streaming approach). 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from get_json_file
WITH(
	  DriveId=''b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0''
	, FileId=''root:/MyFolder/dump.json.zip:''
  , Filter=''$.store.books[*]'' --or just blank (see help file for more filter examples)
  , FileCompressionType=''Zip'' --None, GZip, Zip
)';

EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];

get_json_file endpoint belongs to FileReaderWriterJson table(s), and can therefore be used via those table(s).