Get Employee

UiPath.BambooHR.IntegrationService.Activities.GetEmployee

Description

Retrieves an employee record from BambooHR.

Project Compatibility

Windows|Cross-platform

Configuration

To enter your Get employee property values, click the Configure Object button.

• Employee ID - Select the employee from the dropdown or pass a custom employee ID. ID can also be retrieved from the output of event trigger or Create Employee.

• Fields - Comma separated list of values taken from the official list of field names.

  Check List all records > Meta Fields for the official field names, where alias is a field name that contains the exact field names of all the available queryable properties (e.g., firstName,lastName) that can be used as input to the Fields parameter.

  The Fields parameter is required to get the fields in the response.

• Employee - The output employee object.

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.