Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap Snap to delete items from the SharePoint Online document library.Image Removed

...

Snap Type

SharePoint Online - Delete Item Snap is a Write-type Snap.

Prerequisites

  • Valid SharePoint

    Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works

...

in Ultra Pipelines.

...

To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines However, we recommend that you not use this Snap in an Ultra Pipeline.

Limitations and Known Issues

None.

Snap

...

Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Parser
  • JSON Parser

    An input document contains the data that need to be deleted.


    Output

    Document

    • Min: 1

    • Max: 1

    Mapper Snap
  • Copy Snap
    • CSV

    Parser
    • Formatter

    JSON Parser
    • Filter

    An output document contains the response after the delete operation.

    Error

    Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

    • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

    • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

    • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

    Learn more about Error handling in Pipelines.

    Snap Settings

    ...

    Info
    • Asterisk (*): Indicates a mandatory field.

    • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ((blue star)): Indicates that you can add fields in the field set.

    • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

    Field Name

    Field Type

    Description

    Label*

    Default Value

    Example 

    Label

    String

    Required. The

    SharePoint Online - Delete Item
    Example: SharePoint Online - Delete Item

    String

    Specify 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.

    NSite

    Site*

    Default Value: N/A

    SharePoint Online - Delete Item

    ExampleMySite

    String

    Required. The

    /Expression

    Specify the name of a site

    that

    which contains the list of document library to be used in the subsequent Snap settings.

    N/A

    MySite

    Custom Site Path

    Check-box Insert excerptSharePoint Online - Get ItemSharePoint Online - Get ItemnopaneltrueNot SelectedSelected

    Document Library

    String

    Required. This property enables you to select

    Default ValueDeselected

    Checkbox

    Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has the prefix ‘site/’ before the sitename, a custom site can contain the prefix ‘team/’ or it can have no prefix.

    Document Library*

     

    Default Value: N/A
    ExampleShared Documents

    String/Expression

    Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field

    populates

    will be populated dynamically from different sites

    via

    from the suggestion drop-down list. You can either choose a document library from

    the

    suggestion drop-down list or enter the entity name manually.

    WarningtitleNote

    If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

    NRequired. The item 

    Source item Relative Path*

     

    Default Value: N/A

    Shared Documents

    Source file path

    String

    ExampletestFile.pdf

    String/Expression

    Specify the item 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

    You can use this fieldset to influence

    Use this field set to specify connection properties to the SharePoint Online APIs.

    This fieldset comprises the following fields:

    • Connection timeout
    • Number of retries
    • Retry interval (seconds)

    Connection timeout

    IntegerRequired. Enables you to set

     

    Connection Timeout*

    Default Value30
    Example40

    Integer

    Specify the connection timeout duration in seconds.

    3030

    Number of retries

    IntegerRequired. Enables you to set

    Number of Retries*

    Default Value0
    Example5

    Integer

    Specify the maximum number of

    re-connections

    reconnections in case of a connection failure or timeout.

    11

    Retry

    interval

    Interval (seconds)*

    Default Value1
    Example11

    Integer

    Required. Enables you to set

    Snap Execution

    String

    Specify the 

    Specify the time interval in seconds between connection attempts.

    1010

    Snap Execution

    Default ValueExecute only
    ExampleValidate & Execute

    Dropdown list

    Specify the required Pipeline 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

    Validate & Execute

    Info

    For more information on how to delete an item in the SharePoint Online refer to the graph API in driveItem-delete.

    Troubleshooting

    Error

    Reason

    Resolution

    The input entity does not exist.

    An invalid entity has been entered.

    Please click

    Click the suggestion drop-down button and select the entity.

    Examples

    Deleting an Item

    This example demonstrates how to delete a specified item. This example will upload a file to the SharePoint Online and then performs the same item to delete. The example assumes that you have configured & and authorized a valid SharePoint Online Account (see . For more information, refer to SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the settings of the SharePoint Online - Delete Item Snap.Image Removed

    ...

    After successfully validating/executing the above Snap, the results display result displays in the following output preview.Image Removed

    ...

    Download this Pipeline.

    Downloads

    Noteinfo
    title

    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.

    Attachments
    patterns*.slp

    Snap Pack History

    Expand

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nameSharePoint Online SPH
    nopaneltrue

    See Also

    ...

    Related Content

    ...

    ...