OpenProject

Interact with OpenProject API

Overview

This node allows users to interact with the OpenProject API specifically for managing Time Entries. It supports making custom API calls to any endpoint related to time entries, using various HTTP methods such as GET, POST, PUT, PATCH, and DELETE. This flexibility enables users to retrieve, create, update, or delete time entry data as needed. Common scenarios include logging work hours, retrieving time entry records for reporting, or integrating time tracking with other systems.

Use Case Examples

  1. Create a new time entry by specifying the work package, hours spent, date, and optional comments.
  2. Retrieve all time entries or filter them by a specific work package.
  3. Make a custom API call to update or delete a time entry using the appropriate HTTP method and endpoint.

Properties

Name Meaning
HTTP Method The HTTP method to use for the API call (GET, POST, PUT, PATCH, DELETE). This determines the type of operation performed on the time entry resource.
Endpoint The API endpoint to call, e.g., /api/v3/time_entries. This specifies the exact resource path for the API request.
Request Body The request body in JSON format, used for POST, PUT, and PATCH methods to send data to the API.
Query Parameters Query parameters to include in the API request URL, allowing filtering or other query options.
Additional Headers Additional HTTP headers to include in the API request, such as custom authentication or content-type headers.

Output

JSON

  • json - The JSON response from the OpenProject API call, which can be a single object or an array of objects representing time entries or other data returned by the API.

Dependencies

  • Requires an API key credential for OpenProject API authentication, typically provided as a base URL and API token.

Troubleshooting

  • Ensure the API endpoint and HTTP method are correct and supported by the OpenProject API.
  • Verify that the request body, query parameters, and additional headers are valid JSON when provided; invalid JSON will cause errors.
  • Check that the API token credential is correctly configured and has sufficient permissions for the requested operation.
  • Common error messages include invalid JSON in request body, query parameters, or headers, which can be resolved by correcting the JSON format.
  • If the API returns authorization errors, verify the API token and base URL are correct and active.

Links

Discussion