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 a list item from the SharePoint Online site.Image Removed

...

Snap Type

SharePoint Online - Delete List 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 metadata of the list item 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. If successful, the Snap returns a 204 No Content response to indicate that resource was deleted and there was nothing to return

    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

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

    String

    Required. The

    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 List 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

    Default ValueDeselected

    Checkbox

    Excerpt
    -includeSharePoint Online - Get ItemSharePoint Online - Get ItemnopaneltrueNot SelectedSelected

    List Name

    String

    Required. This property enables you to select

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

    List Name*

    Default Value: N/A
    ExampleDemoList

    String/Expression

    Specify the name of the list. This field suggest all the list that belong to the SharePoint Online site. 

    warning

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

    NItem Id

    Item ID*

    Default Value: N/A

    DemoList

    ExampleADDS44262GGGATs53

    String

    Required. Select or enter the item id

    /Expression

    Enter the item ID to delete the list item.

    N/A

    1

    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

    Specify the time interval in seconds between connection attempts.

    1010

    Snap Execution

    String

    Specify the required Pipeline the

    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 a list item in SharePoint Online, refer to the graph API in List Item-Delete

    Troubleshooting

    Error

    Reason

    Resolution

    The specified listName/itemId was not found

    Entered listname/itemId might not be available in the site

    Click the suggestion drop-down button and select the listName or enter the existing list name manually or verify the itemid is entered existence.

    Forbidden exception

    Either user or app doesn't have sufficient permissions to read the metadata for the document library.

    Ensure to provide the desired permissions both at the user and application level.

    Examples

    Deleting a List Item

    This example demonstrates how to delete a particular list item from the specified list Name. The example assumes that you have configured and authorized a valid SharePoint Online Account (see SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the SharePoint Online Delete Online Delete List Item Snap. The Snap specifies to delete the list item created in the previous snap.Image Removed

    ...

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

    ...

    Download this Pipeline.

    Downloads

    title
    Note
    Info

    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

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nopaneltrue

    ...

    See Also

    Child pages (Children Display)
    pageSharePoint Online Snap Pack
    sorttitle