Endpoint Read List
Name
get_list
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 |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Name |
DT_WSTR
|
nvarchar(300)
|
300 | |
| displayName |
DT_WSTR
|
nvarchar(188)
|
188 | |
| ParentReferenceSiteId |
DT_WSTR
|
nvarchar(388)
|
388 | |
| ListContentTypesEnabled |
DT_BOOL
|
bit
|
||
| IsListHidden |
DT_BOOL
|
bit
|
||
| ListTemplate |
DT_WSTR
|
nvarchar(88)
|
88 | |
| Description |
DT_WSTR
|
nvarchar(500)
|
500 | |
| CreatedAt |
DT_DBTIMESTAMP
|
datetime
|
||
| CreatedByUserId |
DT_WSTR
|
nvarchar(144)
|
144 | |
| CreatedByUserEmail |
DT_WSTR
|
nvarchar(124)
|
124 | |
| CreatedByUser |
DT_WSTR
|
nvarchar(56)
|
56 | |
| LastModifiedAt |
DT_DBTIMESTAMP
|
datetime
|
||
| LastModifiedByUser |
DT_WSTR
|
nvarchar(48)
|
48 | |
| LastModifiedByUserEmail |
DT_WSTR
|
nvarchar(100)
|
100 | |
| LastModifiedByUserId |
DT_WSTR
|
nvarchar(144)
|
144 | |
| WebUrl |
DT_WSTR
|
nvarchar(300)
|
300 |
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
| Required Parameters | |
|---|---|
| ListId | Fill-in the parameter... |
| Optional Parameters | |
| SiteId (Re-Select ListId after you change this) | |
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
| Required Parameters | |
|---|---|
| ListId | Fill-in the parameter... |
| Optional Parameters | |
| SiteId (Re-Select ListId after you change this) | |
ODBC application
Use these SQL queries in your ODBC application data source:
Read list
SELECT * FROM get_list
WITH
(
"ListId" = 'abcd-1234-listid'
)SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read list
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_list
WITH
(
"ListId" = ''abcd-1234-listid''
)';
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];