Endpoint Delete List Item
Name
delete_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 |
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 |
---|---|---|---|---|
Output |
DT_WSTR
|
nvarchar(2000)
|
2000 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(200)
|
200 |
Examples
SSIS
Use SharePoint Online Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
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) |

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 delete 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) |

ODBC application
Use these SQL queries in your ODBC application data source:
Delete list item (SharePoint Document Library)
DELETE FROM delete_list_item
WITH (ListId='14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX'
,ListItemId='775')
--You can get ListId by selecting from 'list_lists' endpoint.
--ListItemId can be retrieved by selecting from 'get_list_items' endpoint.
Delete item from a named list
DELETE FROM MyList WHERE Id=888
--OR--
DELETE FROM MyList WITH (ListItemId='123')
--ListItemId can be retrieved by selecting from named list table, e.g. 'MyList'.
delete_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:
Delete list item (SharePoint Document Library)
DECLARE @MyQuery NVARCHAR(MAX) = 'DELETE FROM delete_list_item
WITH (ListId=''14bdfd1d-1090-4cfe-adc1-XXXXXXXXXXXXXX''
,ListItemId=''775'')
--You can get ListId by selecting from ''list_lists'' endpoint.
--ListItemId can be retrieved by selecting from ''get_list_items'' endpoint.';
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];
Delete item from a named list
DECLARE @MyQuery NVARCHAR(MAX) = 'DELETE FROM MyList WHERE Id=888
--OR--
DELETE FROM MyList WITH (ListItemId=''123'')
--ListItemId can be retrieved by selecting from named list table, e.g. ''MyList''.';
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];
delete_list_item
endpoint belongs to
[Dynamic Table]
, ListItems
table(s), and can therefore be used via those table(s).