Everhour icon

Everhour

Interact with Everhour API
Join our community

Actions32

Overview

This node interacts with the Everhour API to update an existing assignment for a user. Assignments in Everhour represent allocations of users to projects or time off periods, including scheduling details such as start and end dates and scheduled time.

Typical use cases include:

  • Modifying the details of a user's project assignment, such as changing the scheduled time or assignment period.
  • Updating time-off assignments for users.
  • Adjusting assignments programmatically as part of workforce management or project planning workflows.

For example, you might use this node to extend a user's project assignment end date or increase the scheduled time allocated to a task.

Properties

Name Meaning
User ID The numeric identifier of the user whose assignment is being updated.
Assignment ID The numeric identifier of the specific assignment to update.
Assignment Type The type of assignment; options are: "Project" or "Time Off".
Project ID The project identifier associated with the assignment (required if assignment type is "Project").
Start Date The start date and time of the assignment (ISO 8601 format).
End Date The end date and time of the assignment (ISO 8601 format).
Scheduled Time (Seconds) The amount of scheduled time for the assignment expressed in seconds.
Force Override A boolean flag indicating whether to force override any existing conflicting assignments.

Output

The node outputs the JSON response from the Everhour API after updating the assignment. This typically includes the updated assignment object with its properties reflecting the changes made.

The output structure is a JSON object representing the assignment resource, which may contain fields such as:

  • id: Assignment identifier
  • type: Assignment type ("project" or "time-off")
  • user: User ID
  • project: Project ID (if applicable)
  • startDate: Start date/time
  • endDate: End date/time
  • scheduledTime: Scheduled time in seconds
  • Other metadata related to the assignment

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Everhour API.
  • The node uses HTTP methods (PUT) to communicate with the /assignments/{assignmentId} endpoint of the Everhour API.
  • Proper configuration of the API base URL and authentication credentials within n8n is necessary.

Troubleshooting

  • Invalid Assignment ID: If the assignment ID does not exist or is incorrect, the API will return an error. Verify the assignment ID before updating.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to update assignments.
  • Date Format Issues: Start and end dates must be in a valid ISO 8601 datetime format. Invalid formats may cause request failures.
  • Force Override Conflicts: If there are overlapping assignments and forceOverride is not set to true, the update might fail due to conflicts.
  • Missing Required Fields: For project assignments, the projectId must be provided. Omitting required fields will result in errors.

To resolve errors, check the error message returned by the API, verify input parameters, and ensure proper credential setup.

Links and References

Discussion