SharePoint Online - Get Delta Changes

SharePoint Online - Get Delta Changes

Overview

You can use this Snap to track changes such as create, update, or delete in the metadata of items (files/folders/list) from the SharePoint Online document library using delta queries for synchronizing data efficiently without repeatedly fetching the entire dataset. Learn more about retrieving delta changes.

Delta Snap- Overview.png

 

Snap Type

SharePoint Online - Get Delta Changes is a Read-type Snap.

Prerequisites

  • Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Tasks

Works in Ultra Tasks

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: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

An input document contains the metadata of the item to be retrieved, such as, site, item name, etc.

 

Output

Document

  • Min: 1

  • Max: 1

  • CSV Parser

  • JSON Parser

An output document contains the metadata information of an item.

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 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 ValueSharePoint Online - Get Delta Changes
ExampleSharePoint Online - Get Delta Changes

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.

Delta type

Default ValueDocument Library
ExampleList

Dropdown list

Choose the delta type to fetch the changes. Available options are:

  • Delta Link

  • Document Library

  • List

Site

 

Default Value: N/A
ExampleMySite

String/Expression

Specify the name of a site that contains metadata for a SharePoint site.

Custom site path

 

Default ValueDeselected

Checkbox

Select this checkbox 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.

Delta link

 

Default Value: N/A
Examplehttps://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items/delta?token={delta-token}

 

String/Expression

This field appears only when Delta Type is set to Delta Link. Specify the link to fetch the delta changes.

Document library

 

Default Value: N/A
ExampleShared Documents

String/Expression/Suggestion

This field appears only when Delta Type is set to Document Library. Specify the drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field is populated dynamically from different sites in the suggestion dropdown list. You can either choose a document library from the suggestion dropdown list or enter the entity name manually.

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

 

List name

 

Default Value: N/A
ExampleShared Lists

String/Expression/Suggestion

This field appears only when Delta Type is set to List. Specify the resource containing the top-level properties of the list in a site, including template and field definitions. This field will be populated dynamically from different sites from the suggestion drop-down list. You can either choose a list name from the suggestion drop-down list or enter the entity name manually.

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

 

Select fields

 

Default Value: N/A
Exampleid, email, roles

String/Expression

Enter the comma-separated properties to be written to the output view.

Expand

Default ValueDeselected

String

Enter the comma-separated properties to retrieve from the fields section of a list. This is an optional field that appears only when the Delta Type is set to List.

Auto pagination

Default Value: Deselected

Checkbox

Select this checkbox to retrieve all matching records as a paginated list.

Connection details

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

Connection timeout*

 

Default Value30
Example40

Integer

Specify the duration (in seconds) for which the Snap should attempt to connect to SharePoint Online. If the connection fails within this duration, the Snap times out, logs the event, and waits for the defined Retry Interval before retrying.

Number of retries*

 

Default Value3
Example5

Integer

Specify the maximum number of reconnection attempts the Snap must perform in case of a connection failure or timeout.

Retry interval (seconds)*

 

Default Value10
Example11

Integer

Specify the duration (in seconds) the Snap must wait between reconnection attempts, until the maximum number of retries is reached.

Snap execution

 

Default ValueValidate & Execute
ExampleExecute only

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

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

For more information on how to retrieve details of an item in the SharePoint for a delta operation, refer to the graph API ListItem-Delta and DriveItem-Delta.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

HTTP Response Code:404

Entered item not found in the document library

Provide a valid item path to get the metadata.

Forbidden exception:403

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

Provide the desired permissions both at the user and application levels.

Examples

Retrieve delta changes

This example demonstrates how to retrieve data, track changes, and obtain the latest updates since your previous query. The example assumes that you have configured and authorized a valid SharePoint Online Account or SharePoint Online Application Account.

GetDeltaPipeline.png

Download this Pipeline.

Configure the SharePoint Online - Get Delta Changes Snap as follows. The Snap is configured to get the metadata of a List. It also retrieves the content of the list that has been specified.

Example_SnapSS.png

After successfully validating or executing the Snap, the results appear in the output preview.

SnapOutput.png

The final page of the item includes the @odata.deltaLink property, which provides the URL that can be used later to retrieve changes since the last data retrieval.

To retrieve the latest changes using the @odata.deltaLink property, update the Delta Type field in the Snap UI to Delta Link, and provide the link in the corresponding field, as shown in the example below.

DeltaLinkSnap.png

 

Downloads

Important steps to successfully reuse pipelines

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_Sharepoint-GetDeltaChanges.slp

May 29, 2025 by Kalpana Malladi

Snap Pack History


Related Content