SharePoint REST Update ListItem

The SharePoint REST Update ListItem activity not only supports updating one or more list items in a specific Microsoft SharePoint list.

This activity supports the following functions:

  • Updating a data item or a folder in a generic list.
  • Updating a document library item, a document link, or a folder in a document library.
  • You can update multiple list items at a time. You can also use the For-Each statement to map the collection of list items to the current activity.

The activity only supports using the list item ID to update list items. If you want to use other query conditions, you have to use the SharePoint REST Add ListItem activity to select the list item first, and then use the SharePoint REST Update ListItem activity to update the list item.

Note: It does not support uploading an item of any content type under Microfeed list type.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list item that you want to update in Microsoft SharePoint, and set the Timeout time for calling the process.

The following table lists the configurations in the General tab of the SharePoint REST Update ListItem activity:

Field Module Property? Description
Name No (Required) Specify the name to be displayed as the label for the activity in the process. The default value is SharePointRESTUpdateListItem.
SharePoint REST Connection  Yes (Required) Click the icon to select a SharePoint connection.

If no matching SharePoint Connection shared resources are found, click Create Shared Resource to create one. See Creating a SharePoint REST Connection for more details.

Web Name No (Required) Get the target website.

Click Fetch Webs to get available websites from the site collection specified in the SharePoint REST Connection shared resource.

List Name No (Required) Get the list that you want to operate on.

Click Fetch Lists to get available lists from the site selected in the Web Name field.

Content Type No (Required) Specify the content type used to define the list item.

Click Fetch Content Types to get available content types of the selected list.

Note: The content type of list specified in this activity should match with the content type of the list which you have created earlier.
Upload Document No (Required) Specify whether to upload a document.

This field is displayed when you select a Document content type.

Timeout(sec) Yes (Required) Specify how long the plug-in waits for the process to perform the update operation. The default value is 120.
Note: The update operation might fail or succeed if it times out when started at run time. The result is undefined. You have to provide enough time for the update operation to perform.

Description

On the Description tab, you can enter a short description for the SharePoint REST Update ListItem activity.

Input

On the Input tab, you can specify the list item that you want to update.

The following table lists the input elements on the Input tab of the SharePoint REST Update ListItem activity:

Input Item Data Type Description
WebName String The target website. You can update list items by using the activity across Microsoft SharePoint sites. You can add a group to this activity, and get the site from a previously performed activity in the current process.
Note: The value specified in this input item takes precedence over the one set in the General tab.
Items N/A The attributes of the new item. The attributes vary with different content types. See Input Guidelines for details about how to provide a valid input.
Note: You must provide a value for the ID attribute. If you leave other attributes empty, the value of the attribute is not updated on the Microsoft SharePoint server.
Upload Document to Document Library

The following input items are displayed when you update a document in the Microsoft SharePoint document library.

LocalFileLocation String The location of the source file.
Note: You must specify a value in this input item or in the FileContent input item.
FileContent Binary The binary content of a file, which is transferred from a previous activity in a process.
Note: The size of the file must be less than 100 MB.

Output

On the Output tab, the Success node lists the status of all the operations, and the Results node lists the status of the current operation.

The following table lists the output elements on the Output tab of the SharePoint REST Update ListItem activity:

Output Item Data Type Description
Success Boolean This property indicates the status of all of the operations. If no error occurs when updating one or more records, the status true is returned.
Results
Result   The Result element contains the following elements:
  • Success (a Boolean value): this property indicates the status of the current operation. If no error occurs when updating a record, the status true is returned.
  • ErrorMessage (a String value): the message returned from the Microsoft SharePoint system.
  • Item: the output of each attribute of the new item. It varies with different content types. For the meaning of each attribute, see the Microsoft SharePoint documentation for more details.

Fault

On the Fault tab, you can find the error code and error messages of the SharePoint REST Update ListItem activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements on the Fault tab of the SharePoint REST Update ListItem activity:

Error Schema Element Data Type Description
SharePointRestPluginException
msg String Displays the error message returned by the plug-in.
msgCode String Displays the error code returned by the plug-in.
ShareRestPointRemoteException
msg String Displays the error message of the Microsoft SharePoint system when processing a request from the plug-in.
msgcode String Displays the error code of the Microsoft SharePoint system when processing a request from the plug-in.
encoding String Displays the error encoding of the Microsoft SharePoint system when processing a request from the plug-in.
ActivityTimedOutException
msg String Displays the error message when the SharePoint REST Update ListItem operation times out.
msgcode String Displays the error code when the SharePoint REST Update ListItem operation times out.