Search Employees Directory

UiPath.BambooHR.IntegrationService.Activities.EmployeesDirectory

Searches the Employees Directory.

The Employee Directory feature needs to be enabled in your account to use this activity to get a list of employees from BambooHR.

Note: Employee Directory can usually be modified by Admin (with full access). All other normal users have just the read access. There are also access levels on how many records can be retrieved in Employee Directory. This is a limitation from the vendor for trial/limited access accounts. You can refer to Get Employee Directory.

In the body of the activity

• Fields - A comma separated list of values taken from the official list of field names. Check "Invoke Meta Fields" for the official field names. For example: firstName,lastName.
• Employees Directory - The response from the employees directory.

Properties

Common

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

Misc

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

Output

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