SharePoint Online - Update List Item

In this article

Overview

You can use this Snap to update the values of an existing list item in the SharePoint Online site.

Snap Type

The SharePoint Online - Update List Item Snap is Write-type Snap that updates the items in the Microsoft SharePoint Online site.

Prerequisites

  • Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in 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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

  • CSV Parser

  • JSON Parser

An input document contains the of a fieldValueSet specifying the fields to be updated.

Output

Document

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

An output document contains the response after the list update 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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when 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

  • Asterisk (*): Indicates a mandatory field.

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

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

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

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

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*


Default Value: SharePoint Online - Update List Item
Example: SharePoint Online - Update List 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.

Site*


Default Value: N/A
Example: MySite

String/Expression

Specify the site name that contains the list of document library to be used in the subsequent settings.

Custom Site Path

 

Default Value: Deselected

Checkbox

List name*


Default Value: N/A
Example: DemoList

String/Expression

Specify or select the name of the list. This field suggests all the list that belong to the SharePoint Online site. 

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



Item ID*


Default Value: N/A
Example: WEE463484feffw

String/Expression

Select or enter the item id from the suggestion dropdown list of a specific list or use the expression to pass from the upstream document to perform the update item.

Learn more about deleting an item in the SharePoint Online: Refer to the graph API in List Item-Update

Connection details

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

Connection Timeout*

 

Default Value: 30
Example: 40

Integer

Specify the connection timeout duration in seconds.

Number of Retries*

 

Default Value: 0
Example: 5

Integer

Specify the maximum number of reconnections in case of a connection failure or timeout.

Retry interval (seconds)*

 

Default Value: 1
Example: 11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution


Default Value: Execute only
Example: Validate & Execute

Dropdo

Select one of the three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

The specified listName/itemID was not found.

The listname/itemID that you have entered might not be available in the site

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

Forbidden exception

Either user or app does not 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

Updating a List Item

This example demonstrates how to update a particular list item from a specified SharePoint Online list name. The example assumes that you have configured and authorized a valid SharePoint Online Account (see SharePoint Online Account).

The following screenshot displays the settings of the SharePoint Online Update List Item Snap. This Snap specifies on how to update the values of a list item created in its previous Snap.

After successfully validating/executing the above Snap, the results display as follows:

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 Example_ListItemUpdate.slp

Nov 21, 2022 by Kalpana Malladi

Snap Pack History


Related Content