HCSS Heavy Job icon

HCSS Heavy Job

Read, update, write and delete data from HCSS Heavy Job API

Actions8

Employee → Search

AI-generated

Overview

This node performs a search operation for employees within the HCSS Heavy Job API. It allows users to find employees based on a specified business unit and a search field-value pair, such as searching by employee code or email. This is useful for scenarios where you need to retrieve employee details filtered by specific criteria within a business unit, for example, to verify employee information or to integrate employee data into workflows.

Use Case Examples

  1. Search for an employee by their unique code within a specific business unit.
  2. Find an employee by their email address to retrieve contact details or employment status.

Properties

Name Meaning
Business Unit Code Name or ID Specifies the business unit to which the employee belongs. This is required to scope the search within a particular business unit.
Search Field The field to search by, either 'Code' or 'Email'. This determines which employee attribute the search will filter on.
Search Value The value to search for in the selected search field. This is the actual code or email to match against employee records.

Output

JSON

  • code - Employee's unique code identifier.
  • email - Employee's email address.
  • firstName - Employee's first name.
  • lastName - Employee's last name.
  • businessUnitCode - Code of the business unit the employee belongs to.
  • additionalFields - Other employee details returned from the API, such as department, phone, status, etc.

Dependencies

  • HCSS Heavy Job API with valid API credentials

Troubleshooting

  • Ensure the business unit code or ID is valid and accessible; invalid or missing business unit information will cause the search to fail or return no results.
  • Verify that the search field and value are correctly specified; searching by an unsupported field or empty value will yield no results.
  • API authentication errors may occur if the API credentials are incorrect or expired; re-authenticate or update credentials as needed.

Links

Discussion