OpenProject

Interact with OpenProject API
Join our community

Actions15

Overview

This node allows users to interact with the OpenProject API specifically for the 'Project' resource using a custom API call operation. It supports making HTTP requests with various methods (GET, POST, PUT, PATCH, DELETE) to any specified API endpoint related to projects. Users can provide query parameters, additional headers, and a JSON request body for methods that support it. This flexibility enables users to perform any custom API operation on projects that may not be covered by predefined operations, such as fetching project details, creating new projects, updating existing ones, or deleting projects.

Use Case Examples

  1. Fetching a list of all projects by making a GET request to '/api/v3/projects'.
  2. Creating a new project by sending a POST request with a JSON body containing project details to '/api/v3/projects'.
  3. Updating a project by sending a PATCH request with updated fields to '/api/v3/projects/{projectId}'.
  4. Making a custom DELETE request to remove a project using the endpoint '/api/v3/projects/{projectId}'. Potentially adding custom headers or query parameters as needed.

Properties

Name Meaning
HTTP Method The HTTP method to use for the API call (GET, POST, PUT, PATCH, DELETE). Determines the type of operation performed on the API endpoint.
Endpoint The specific API endpoint to call, e.g., '/api/v3/projects'. Defines the target resource or action within the OpenProject API.
Request Body The JSON-formatted request body sent with POST, PUT, or PATCH requests. Contains data to create or update a resource.
Query Parameters JSON-formatted query parameters to include in the API request URL. Used to filter or modify the request.
Additional Headers JSON-formatted additional HTTP headers to include in the API request. Used for custom authentication or other header-based configurations.

Output

JSON

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

Dependencies

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

Troubleshooting

  • Ensure that the JSON provided in 'Request Body', 'Query Parameters', and 'Additional Headers' is valid JSON format; invalid JSON will cause errors.
  • Verify that the API endpoint and HTTP method are correct and supported by the OpenProject API to avoid 404 or method not allowed errors.
  • Check that the API token credential is correctly configured and has sufficient permissions for the requested operation.
  • If the node throws errors related to missing fields or invalid data, review the API documentation for required fields and data formats.

Links

Discussion