OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation allows users to create a new time entry in the OpenProject system. It is useful for tracking work hours, logging time spent on tasks or projects, and managing ongoing time tracking activities. Typical use cases include recording billable hours, noting time spent on specific work packages, or starting/stopping timers for active work sessions.

For example, a project manager can automate the creation of time entries when team members submit their daily work logs, or a freelancer can track ongoing work time automatically by creating time entries with the "ongoing" flag set.

Properties

Name Meaning
Id The unique identifier of the time entry to be created.
Comment A formatted comment attached to the time entry. Supports JSON format with markdown, raw text, and HTML.
Spent On The date for which the time expenditure is booked (e.g., the day the work was done).
Hours The amount of time spent, expressed as a string (e.g., "2.5" for two and a half hours).
Ongoing Boolean indicating whether the time entry is actively tracking time (true if timer is running).
Created At Timestamp representing when the time entry was created.
Updated At Timestamp representing when the time entry was last updated.
Links JSON object containing related API links and actions such as self-reference, update, delete, schema, and relations to project, work package, user, and activity.

Output

The node outputs the created time entry data in JSON format. This includes all properties sent during creation along with any additional metadata returned by the OpenProject API, such as unique identifiers, timestamps, and relational links.

If the node supports binary data output, it is not indicated here; thus, the output is purely JSON-based representing the newly created time entry.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • Depends on the OpenProject REST API endpoint for creating time entries (POST /api/v3/time_entries or similar).
  • Uses JSON content type for request and response payloads.

Troubleshooting

  • Invalid or missing API credentials: Ensure that the API key and base URL are correctly configured in the node credentials.
  • Incorrect date or time formats: The spentOn, createdAt, and updatedAt fields should follow the expected date/time format accepted by OpenProject (usually ISO 8601). Invalid formats may cause API errors.
  • Malformed JSON in Comment or Links: The comment and _links properties expect valid JSON strings. Improper formatting will lead to parsing errors.
  • API endpoint errors: If the OpenProject API returns errors (e.g., 400 Bad Request, 401 Unauthorized), verify the request body matches the API schema and authentication is valid.
  • Ongoing flag misuse: Setting ongoing incorrectly might cause logical errors in time tracking. Use true only when the time entry is actively tracking time.

Links and References

Discussion