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.
- Complete the Setup steps.
- Add the ServiceNow Scope activity to your project.
- Add the Get ServiceNow Record activity inside the ServiceNow Scope activity.
- Click the Configure button inside the Get ServiceNow Record activity (this opens the Object Wizard).
- Select the Object that you want to retrieve and enter, at a minimum, the sys_id of the record.
- 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.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Get ServiceNow Record |
Allowed values | Enter a |
Notes | N/A |
Advanced
AdditionalFields
A DataRow
that includes the columns and values that you want to retrieve.
Attributes | Details |
---|---|
Type |
|
Required | No |
Default value | Empty |
Allowed values | Enter a |
Notes | The column names must match the names as they appear in the ServiceNow database table for the selected object type. |
Object wizard
sys_id
The id of the ServiceNow record that you want to retrieve.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Empty |
Allowed values | Enter a |
Notes | 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 (see example below). |


Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
Attributes | Details |
---|---|
Type | Checkbox |
Required | No |
Default value | Not Selected |
Allowed values | Selected or Not Selected |
Notes | N/A |
Output
ServiceNowStatus
The status of the request (success/failure information).
Attributes | Details |
---|---|
Type |
|
Required | No (required if you want to use the output data in subsequent activities) |
Default value | Empty |
Allowed values | Enter a UiPath.BAF.Models.ResponseStatus |
Notes | The |
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.


Updated 2 months ago