HCSS Heavy Job icon

HCSS Heavy Job

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

Actions7

Overview

This node integrates with the HCSS Heavy Job API to manage employee data within a specified business unit. The Employee - Search operation allows users to find employees by searching for a specific field (either "Code" or "Email") and matching it against a provided value within a given business unit.

Typical use cases include:

  • Quickly retrieving employee details based on their unique code or email address.
  • Automating workflows that require employee verification or lookup before proceeding.
  • Integrating employee search functionality into broader HR or project management automation.

For example, you might use this node to find an employee's record by their email to update their status or assign them to a job.

Properties

Name Meaning
Business Unit Code Name or ID Select the business unit from a dropdown list or specify its ID via expression. This scopes the employee search to a particular business unit.
Search Field Choose the field to search by: either "Code" (employee code) or "Email" (employee email address).
Search Value Enter the exact value to search for in the selected search field.

Output

The output is a JSON array of employee objects filtered by the search criteria. Each object represents an employee record containing all available fields returned by the API for that employee.

Example structure of each employee object (fields may vary):

{
  "id": "string",
  "code": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "businessUnitCode": "string",
  // ... other employee-related fields
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the HCSS Heavy Job API.
  • The node depends on the external HCSS Heavy Job API service being accessible.
  • The "Business Unit Code Name or ID" property dynamically loads options from the API, so network connectivity and valid credentials are necessary for this feature.

Troubleshooting

  • Empty results: If no employees are returned, verify that the business unit code is correct and that the search value exactly matches an existing employee's code or email.
  • Authentication errors: Ensure the API key credential is correctly configured and has not expired.
  • Network issues: Confirm that the n8n instance can reach the HCSS API endpoints.
  • Invalid parameters: Make sure required fields ("Business Unit Code Name or ID", "Search Field", and "Search Value") are provided and valid.
  • API rate limits or downtime: Check the HCSS API status if requests fail unexpectedly.

Links and References

Discussion