Search ServiceNow Records

UiPath.ServiceNow.Activities.SearchRecords

The Search ServiceNow Records activity uses the ServiceNow Table - GET API to retrieve specific records (Object) using your encoded query string (Query).

After retrieving the records, the activity outputs the result of the query as a DataTable object (Result) and the status of the request (success/failure information) in a ResponseStatus object (ServiceNowStatus). Both of these outputs can be used as input variables in subsequent activities (e.g., conditional logic).

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 Search ServiceNow Records activity inside the ServiceNow Scope activity.
4. Click the Configure button inside the Search ServiceNow Records activity (this opens the Object Wizard).
5. Select the Object that you want to retrieve and enter values for the Input properties.
6. Create and enter DataTable and ResponseStatus variables for the Output properties.
   • Your input property values are sent to the Table - GET API.
   • The API returns the DataTable and ResponseStatus values to your output property variables.
     
     

     

     
     

In the Body of the Activity

To enter your Search ServiceNow Records property values and/ test your Query inputs, you can use the Object Wizard by clicking the Configure button.

To learn more about the Object Wizard, see the Business Activity Frameworks page.

• Object - The type of ServiceNow object that you want to retrieve. Use the Object Wizard to select an object or enter a valid String or String variable. If you use the Object Wizard to select your object, you must also use it to change your selection. Changes made without using the object wizard causes the activity to fail gracefully.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input

• Query - The filter parameters. Enter a String or String variable.
  • Enter your query following the ServiceNow encoded query string format (e.g., "sysparm_query=short_descriptionLIKEUiPath&sysparm_fields=number,short_description").
  • To build your query, its recommended that you follow the steps to generate an encoded query string through a filter in the ServiceNow documentation.
  • To test your query, open the Object Wizard, enter your String (without quotes ("")) and click the Test Query button to see the results.
  • The query String that you enter in the Object Wizard also populates the Query property in the Properties Panel.

    More information on how to create queries easily is described at How to use Search ServiceNow Records.

Misc

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

Output

• Result - The results of the Query. Enter a DataTable variable.
• ServiceNowStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object 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.

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 guides.