In this article
Can be used to update the rename or move an item (file or folder) within SharePoint Online.
See Snap Support for Ultra Pipelines.
N/A
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing the metadata of the item to be updated. |
Output | Document |
|
| A document containing the updated metadata information of an item returned by SharePoint Online. |
Parameter Name | Data Type | Description | Default Value | Example | |
---|---|---|---|---|---|
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 - Update 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.
| N/A | Shared Documents | |
Source item relative path | String | Required. The driveItem resource path that represents a file, folder, or other item stored in a document library. | N/A | testDrive/testFile.pdf | |
Target document library | String | Optional. This property enables you to select a document library into which the item should be moved. | N/A | DemoDrive | |
Target folder | String | Optional. Enter the target folder item name which will be used as the parent to the item that is being copied. | N/A | testFolder | |
Target item name | String | Required: If provided without the Target Doc library and Target folder then this value will be used to rename the existing file/folder. If provided with the target paths then the item will be moved to the new location with this name i.e. move will be performed. | N/A | testMove.pdf | |
Connection details | N/A | Settings to influence connection properties to the SharePoint Online APIs. | N/A | N/A | |
Connection timeout | int | Required. This property enables you to set the connection timeout duration in seconds. | 30 | 30 | |
Number of retries | int | Required. This property enables you to set the maximum number of re-connections in case of connection failure or timeout. | 0 | 3 | |
Retry interval (seconds) | int | Required. This property enables you to set the time interval in seconds between connection attempts. | 1 | 10 | |
Snap Execution | DropDown | Specifies the execution type:
| Execute only | N/A |
For more information on how to update an item in the SharePoint Online please refer to the graph API, see Update-Item.
Error | Reason | Resolution |
---|---|---|
HTTP Response Code:404 | Entered item not found in the document library | Please ensure to provide the valid item path to get the metadata. |
Forbidden exception:403 | 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. |
Name already exists: 409 | Target item name already exists. | Ensure to provide a unique name for updating the item. |
The example assumes that you have configured & authorized a valid SharePoint Online Account (see Sharepointonline Account).
The following Share Point Online - Update Item snap and pipeline shows how to move a file from one directory to another.
The configuration of the Share Point Online - Update Item snap is shown below. The Snap specifies to move the item to the target as mentioned.
A successful validation or execution of the Snap gives the following output preview, showing the results.
|