Endpoint Read List Item (By ID)
Name
get_list_item
Description
Related Tables
Parameters
Parameter | Required | Options |
---|---|---|
Name:
Label: ListId (Re-Enter ListItemId after you change this) Specify a list id to search items for |
YES | |
Name:
Label: ListItemId Specify a list item id (Record ID) |
YES | |
Name:
Label: SiteId (Re-Select ListId after you change this) Specify a site |
||
Name:
Label: Expand (Output Fields) By default lookup fields are returned as (null). Select fields which you want to process (to speedup processing check only those fields which are (null) in the output) |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(200)
|
200 | |
CreatedOn |
DT_DBTIMESTAMP
|
datetime
|
||
CreatedById |
DT_GUID
|
uniqueidentifier
|
||
CreatedByDisplayName |
DT_WSTR
|
nvarchar(200)
|
200 | |
ModifiedOn |
DT_DBTIMESTAMP
|
datetime
|
||
LastModifiedId |
DT_GUID
|
uniqueidentifier
|
||
LastModifiedDisplayName |
DT_WSTR
|
nvarchar(200)
|
200 | |
[Dynamic Column] |
DT_WSTR
|
nvarchar(2000)
|
2000 | [Dynamic Column] |
[Dynamic Column]LookupId |
DT_I4
|
int
|
[Dynamic Column] Id | |
[Dynamic Column]Label |
DT_WSTR
|
nvarchar(500)
|
500 | [Dynamic Column] Id |
[Dynamic Column]TermGuid |
DT_WSTR
|
nvarchar(100)
|
100 | Managed Meta [Dynamic Column] TermGuid |
[Dynamic Column]WssId |
DT_I4
|
int
|
Managed Meta [Dynamic Column] WssId |
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 [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly:
Required Parameters | |
---|---|
ListId (Re-Enter ListItemId after you change this) | Fill-in the parameter... |
ListItemId | Fill-in the parameter... |
Optional Parameters | |
SiteId (Re-Select ListId after you change this) | |
Continue On 404 Error (When item not found) | True |

API Destination
This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read list item:
Required Parameters | |
---|---|
ListId (Re-Enter ListItemId after you change this) | Fill-in the parameter... |
ListItemId | Fill-in the parameter... |
Optional Parameters | |
SiteId (Re-Select ListId after you change this) | |
Continue On 404 Error (When item not found) | True |

ODBC application
Use these SQL queries in your ODBC application data source:
Read list item
SELECT * FROM get_list_item
WHERE Id = 'abcd-1234-listitemid'
WITH
(
"ListId" = 'abcd-1234-listid'
)
get_list_item
endpoint belongs to
[Dynamic Table]
, ListItems
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 list item
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_list_item
WHERE Id = ''abcd-1234-listitemid''
WITH
(
"ListId" = ''abcd-1234-listid''
)';
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];
get_list_item
endpoint belongs to
[Dynamic Table]
, ListItems
table(s), and can therefore be used via those table(s).