OpenProjectInstall

Overview

This node interacts with the OpenProject API to manage time entries among other resources. Specifically, the "Get" operation for the "Time Entry" resource retrieves detailed information about a single time entry by its unique ID. This is useful in scenarios where you need to fetch and use specific time tracking data from OpenProject within an automation workflow, such as reporting on hours logged or verifying time entry details before further processing.

Practical examples:

• Fetching a particular time entry to display or log its details.
• Using the retrieved time entry data to update related records in other systems.
• Validating that a time entry exists before performing additional operations like updates or deletions.

Properties

Output

The output is a JSON object representing the full details of the requested time entry as returned by the OpenProject API. It includes all standard fields of a time entry such as hours logged, associated activity, comments, date spent, and links to related entities.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "123",
  "hours": "PT1H30M",
  "comment": "Worked on feature X",
  "spentOn": "2024-06-01",
  "_links": {
    "activity": {
      "href": "/api/v3/time_entries/activities/45"
    }
  },
  ...
}

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• The node configuration must include the base URL of the OpenProject instance and the API key.
• Uses HTTP Basic Authentication with the API key encoded in the header.
• Depends on the axios library for making HTTP requests.

Troubleshooting

• Common issues:

  • Invalid or missing Time Entry ID will cause the API call to fail.
  • Incorrect API credentials or base URL will result in authentication errors.
  • Network connectivity problems can prevent successful API calls.

• Error messages:

  • OpenProject error response: <message> indicates the API returned an error message, often due to invalid parameters or permissions.
  • Generic errors may indicate network issues or misconfiguration.

• Resolutions:

  • Verify the Time Entry ID is correct and exists in OpenProject.
  • Check that the API key and base URL are correctly configured in the node credentials.
  • Ensure the OpenProject instance is reachable from the n8n environment.

Links and References

• OpenProject API Documentation
• OpenProject Time Entries API Reference