SharePoint Online - Delete Item

In this article

Overview

This Snap provides the ability to delete items from the SharePoint Online document library.

Prerequisites

  • Use valid SharePoint Online tenant and associated site in account and snap settings respectively.
  • Valid application in the Azure portal with necessary permissions to the application. To learn more, including how to choose permissions, see Permissions.

Support for Ultra Pipelines

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

N/A 

Snap Input and Output


Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A document containing the data that need to be deleted.


Output

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A document containing the response after the delete operation.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

Label

String

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

N/A

SharePoint Online - Delete Item

Site

String

Required.  This property enables you to define the name of a site, which contains the list of document library to be used in the subsequent settings.

N/A

MySite

Document Library

String

Required. This property enables you to select Drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion dropdown. Users are allowed either to choose a document library from suggestion dropdown or type an entity manually.

Note

If an expression is used in the Site property, then the document library cannot be suggested. 

N/A

Shared Documents

Source file path

String

Required. The driveItem resource path that represents a file, folder, or other item stored in a document library.

Note: The snap will delete the folder also even if the folder is not empty.

N/A

testFile.pdf

Connection details

N/ASettings to influence connection properties to the SharePoint Online APIs.N/AN/A

Connection timeout

intRequired. This property enables you to set the connection timeout duration in seconds.3030

Number of retries

intRequired. This property enables you to set the maximum number of re-connections in case of connection failure or timeout.11

Retry interval (seconds)

intRequired. This property enables you to set the time interval in seconds between connection attempts.1010

Snap Execution

DropDown

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Execute only

N/A

For more information on how to delete an item in the SharePoint Online please refer to the graph API, see driveitem-delete.

Troubleshooting

ErrorReasonResolution

The input entity does not exist.

An invalid entity has been entered.

Please click the suggestion dropdown button and select the entity.

Examples

The example assumes that you have configured & authorized a valid Sharepoint Online Account (see SharePoint Online Account).

The following SharePoint Online - Delete Item snap and pipeline shows how to delete a specified item. This example will upload a file to the SharePoint Online and then performs the same item to delete.


Configuration of the SharePoint Online - Delete Item snap is shown as below.


A successful validation or execution of the Snap gives the following output preview, showing the results.




Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Furnish Pipeline parameters as applicable.

  File Modified

File SP_1.0.0_DeleteItem_2020_06_02.slp

Jun 04, 2020 by Rojo Publisher

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'EXPORTSPACE:SharePoint Online Snap Pack'.


See Also