Endpoint Read List Fields
Name
get_list_fields
Description
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: ListId Specify a list id to search items for |
YES | |
|
Name:
Label: SiteId (Re-Select ListId after you change this) Specify a site |
||
|
Name:
Label: Expand |
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
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
Read List Fields
| Required Parameters | |
|---|---|
| ListId | Fill-in the parameter... |
| Optional Parameters | |
| Filter | $.columns[?(@.displayName!='ID')] |
| EnableCustomReplace | True |
| SearchFor | :{} |
| ReplaceWith | :{blank:1} |
| SiteId (Re-Select ListId after you change this) | |
| Expand | columns |
API Destination
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
Read List Fields
| Required Parameters | |
|---|---|
| ListId | Fill-in the parameter... |
| Optional Parameters | |
| Filter | $.columns[?(@.displayName!='ID')] |
| EnableCustomReplace | True |
| SearchFor | :{} |
| ReplaceWith | :{blank:1} |
| SiteId (Re-Select ListId after you change this) | |
| Expand | columns |
ODBC application
Use these SQL queries in your ODBC application data source:
Get list fields
SELECT * FROM get_list_fields
WITH (ListId='2e1d58e4-eced-4d1c-9279-XXXXXXXXXXXXX')
--You can get ListId by selecting from 'list_lists' endpoint.SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get list fields
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_list_fields
WITH (ListId=''2e1d58e4-eced-4d1c-9279-XXXXXXXXXXXXX'')
--You can get ListId by selecting from ''list_lists'' endpoint.';
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];