Classic Integrations Activities
Last updated Jul 17, 2024

Search Records


The Search Records activity uses the SAP SuccessFactors OData API to retrieve a set of records based on OData query parameters you set.

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 (ResponseStatus). Both of these outputs can be used as input variables in subsequent activities (e.g., conditional logic).

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 Search Records activity inside the SuccessFactors Scope activity.
  4. Click the Configure button inside the Search 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 SAP SuccessFactors OData API.
    • The API returns the DataTable and ResponseStatus values to your output property variables.
In the Body of the Activity

To enter your Search 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 SuccessFactors 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.
  • Top - The top number of items to return. Enter a Int32 or Int32 variable.
  • Skip - The number of items to skip. Enter a Int32 or Int32 variable.
  • Search - The query parameter. Enter a String or String variable. Please see Using Search Records for more details regarding advanced use of the Search parameter.
  • Filter - The filter to use. Enter a String or String variable. Please see Using Search Records for more details regarding advanced use of the Filter parameter.
  • Additional Query Parameters - Additional oData query parameters. Enter a String or String variable (e.g. sysparm_limit=5 or priority=2).


  • 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.
  • 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.
  • Results - The results of the Query. Enter a DataTable variable.
  • How it works
  • 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.