UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Get ServiceNow Records

The Get ServiceNow Records activity uses the 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 Get ServiceNow Records 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 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 API - GET API.
    • The API returns the DataTable and ResponseStatus values to your output property variables.

Configure

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

Properties

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

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Get ServiceNow Records

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Object

The type of ServiceNow object that you want to retrieve.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Use the Object Wizard to select an object or enter a valid String or String variable.

Notes

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

Query

The filter parameters.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

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

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

Results

The results of the Query.

Attributes
Details

Type

DataTable

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a DataTable variable.

Notes

N/A


ServiceNowStatus

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

Attributes
Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

  • 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.
  • The example image below shows some of the properties that you can return.

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.

Updated about a month ago


Get ServiceNow Records


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.