OpenProjectInstall

Overview

This node integrates with the OpenProject API, allowing users to perform various operations on different OpenProject resources. Specifically for the Type resource with the Get operation, it retrieves detailed information about a specific type by its ID. This is useful when you want to fetch metadata or configuration details related to types defined in your OpenProject instance.

Common scenarios include:

• Fetching a type's details to display or use in subsequent workflow steps.
• Validating that a type exists before creating or updating work packages or other entities linked to that type.
• Automating reporting or synchronization tasks involving type data.

Example: You have a workflow that processes work packages and needs to enrich them with type information. Using this node, you can get the type details by providing the Type ID.

Properties

Output

The node outputs a JSON object representing the retrieved type resource from OpenProject. The structure corresponds directly to the OpenProject API response for a type, typically including fields such as the type's ID, name, description, and any other metadata provided by the API.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "id": "123",
  "name": "Bug",
  "description": "A problem that needs fixing",
  "_links": {
    "self": {
      "href": "/api/v3/types/123"
    }
  }
}

Dependencies

• Requires an active connection to an OpenProject instance.
• Needs an API key credential configured in n8n for authentication.
• The base URL of the OpenProject API and the API key must be set in the node credentials.
• Uses HTTP Basic Authentication with the API key encoded in Base64.

Troubleshooting

• Error: The resource 'type' is not supported!
  This indicates an invalid resource selection; ensure "Type" is selected as the resource.

• Error: The method 'GET' is not supported!
  This would be unexpected here since GET is supported; verify the operation parameter is correctly set to "Get".

• OpenProject error response: [message]
  This error comes directly from the OpenProject API. Common causes include:

  • Invalid or missing Type ID.
  • Insufficient permissions for the API key.
  • Network connectivity issues.

  To resolve:

  • Double-check the Type ID input.
  • Verify API key permissions.
  • Confirm the OpenProject base URL is correct and accessible.

• Authentication errors
  Ensure the API key credential is properly configured and valid.

Links and References

• OpenProject REST API Documentation
• OpenProject Types API Endpoint (for detailed schema and usage)