The Get ServiceNow Record activity uses the the ServiceNow Table - GET{sys_id} API to retrieve a specific record (sys_id).

After retrieving 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).

This activity also returns the field data associated with the sys_id. For example, if you want to retrieve a ServiceNow incident object, you can output the short_description and contact_type data by adding the fields (with variables) in the object wizard (see example below).

How it works

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.

1. Complete the Setup steps.
2. Add the ServiceNow Scope activity to your project.
3. Add the Get ServiceNow Record activity inside the ServiceNow Scope activity.
4. Click the Configure button inside the Get ServiceNow Record activity (this opens the Object Wizard).
5. Select the Object that you want to retrieve and enter, at a minimum, the sys_id of the record.
6. Create and enter a ResponseStatus variable for the Output property.
   • Your input property values are sent to the Table API - GET{sys_id} API.
   • The API returns the ResponseStatus value to your output property variable.

Configure

To enter your Get 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.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

📘

Troubleshooting the property grid

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.

Common

DisplayName

The display name of the activity.

---

Advanced

AdditionalFields

A DataRow that includes the columns and values that you want to retrieve.

---

Object wizard

sys_id

The id of the ServiceNow record that you want to retrieve.

---

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

---

Output

ServiceNowStatus

The status of the request (success/failure information).

---

Example

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.