The Update ServiceNow Record activity uses the the ServiceNow Table - PATCH API to update a specific record (sys_id).
After updating the record, the activity outputs the status of the request (success/failure information) in a
ResponseStatus object (ServiceNowStatus) that you can use in subsequent activities (e.g., conditional logic).
The Update ServiceNow Record and Upsert Records activities use REST APIs to write directly to a production table. The Insert ImportSet Records activity uses the REST Import Set API to write to an import set table from which the data gets transformed into the target production table.
To avoid updating records directly in production tables, it's recommended that you use the Insert ImportSet Records activity to update a new record.
For detailed information, including troubleshooting import set performance, see import sets in the ServiceNow documentation.
The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the ServiceNow Scope activity to your project.
- Add the Update ServiceNow Record activity inside the ServiceNow Scope activity.
- Click the Configure button inside the Update ServiceNow Record activity (this opens the Object Wizard).
- Select the Object that you want to update and enter, at a minimum, the sys_id of the record.
- Create and enter a
ResponseStatusvariable for the Output property.
- Your input property values are sent to the Table - PATCH API.
- The API returns the
ResponseStatusvalue to your output property variable.
To enter your Update ServiceNow Record property values, you must use the Object Wizard by clicking the Configure button.
To learn more about the Object Wizard, see the Business Activity Frameworks page.
- sys_id - The id of the ServiceNow record that you want to update. To get the sys_id value, you can follow one of the methods shown in the ServiceNow unique record identifier (sys_id) documentation or right-click on the record in the ServiceNow UI and select the Copy sys_id option in the pop-out menu.
If you do not see a list of properties for the object you choose, even looking at the "Add Multiple Fields" option, you may not have sufficient permissions in ServiceNow to see object meta data and modify data. Please see Troubleshooting Permission Issues for more details.
- AdditionalFields - A
DataRowthat includes the columns and values that you want to update. The column names must match the names as they appear in the ServiceNow database table for the selected object type.
- DisplayName - The display name of the activity. This field supports only
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
- ServiceNowStatus - The status of the request (success/failure information). Enter a
ResponseStatusvariable (UiPath.BAF.Models.ResponseStatus). The
ResponseStatusobject includes three properties that you can use in other activities.
- Success -
Boolean- Specifies whether the API request was successful.
- ErrorCode -
String- The response error if the API request is unsuccessful (Success=False).
- Message -
String- The error message.
- Success -
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guide.
Updated 2 months ago