Classic Integrations Activities
Last updated Jul 17, 2024

Get Record


The Get Record activity uses the SAP SuccessFactors OData API to retrieve a specific record.

After retrieving the record, the activity outputs the status of the request (success/failure information) in a ResponseStatus object (ResponseStatus) that you can use in subsequent activities (e.g., conditional logic).

This activity also returns the field data associated with the sys_id.

How it works

The following steps are 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 SuccessFactors Scope activity to your project.
  3. Add the Get Record activity inside the SuccessFactors Scope activity.
  4. Click the Configure button inside the Get 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 SAP SuccessFactors OData API.
    • The API returns the ResponseStatus value to your output property variable.

In the Body of the Activity

To enter your Get 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 retrieve. Enter a String or String variable.


  • AdditionalFields - A DataRow that includes the columns and values that you want to get. Enter a DataRow variable. The column names must match the names as they appear in the SuccessFactors database for the record type.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • Record - This field supports only Object variables.
  • ResponseStatus - 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.
  • How it works
  • In the Body of the Activity
  • Properties

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.