OpenProject

Interact with OpenProject API
Join our community

Actions15

Overview

This node allows users to make custom API calls to the OpenProject API using various HTTP methods such as GET, POST, PUT, PATCH, and DELETE. It is useful for scenarios where predefined operations do not cover specific API endpoints or custom requests are needed. For example, users can retrieve project data, create or update work packages, log time entries, or interact with any other OpenProject API endpoint by specifying the HTTP method, endpoint, request body, query parameters, and additional headers.

Use Case Examples

  1. Retrieve a list of projects by making a GET request to /api/v3/projects.
  2. Create a new work package by sending a POST request with a JSON body to /api/v3/work_packages.
  3. Update a time entry by sending a PATCH request with updated fields to the relevant endpoint.
  4. Make a custom DELETE request to remove a resource by specifying the endpoint and method.

Properties

Name Meaning
HTTP Method The HTTP method to use for the API call (GET, POST, PUT, PATCH, DELETE). This determines the type of request sent to the API.
Endpoint The API endpoint to call, e.g., /api/v3/projects. This specifies the 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 request URL, formatted as JSON.
Additional Headers Additional HTTP headers to include in the request, formatted as JSON.

Output

JSON

  • json - The JSON response from the OpenProject API call, which can be an object or an array of objects depending on the request.

Dependencies

  • Requires an API key credential for OpenProject API authentication, used as a Basic Auth header with the API token.

Troubleshooting

  • Ensure that the JSON provided in the Request Body, Query Parameters, and Additional Headers fields is valid JSON to avoid parsing errors.
  • Common error messages include 'Invalid JSON in request body', 'Invalid JSON in query parameters', and 'Invalid JSON in additional headers'. These indicate malformed JSON input and should be corrected before retrying.
  • Authentication errors may occur if the API token is missing or invalid; verify that the OpenProject API credentials are correctly configured.
  • HTTP errors from the API (e.g., 404 Not Found, 401 Unauthorized) indicate issues with the endpoint URL, method, or permissions and should be checked accordingly.

Links

Discussion