OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node interacts with the OpenProject API to manage various resources, including priorities. Specifically, the "Priority" resource with the "Get" operation retrieves detailed information about a single priority by its ID. This is useful when you want to fetch metadata or configuration details about a specific priority level used in project management workflows within OpenProject.

Common scenarios:

  • Fetching the details of a priority to display or use in conditional logic.
  • Validating that a priority exists before assigning it to a work package or task.
  • Integrating OpenProject priority data into other systems or reports.

Example:
You have a priority ID from a previous step and want to get its name, color, or other attributes to decide how to route tasks or notify team members.

Properties

Name Meaning
Priority ID The ID of the priority to retrieve. This is a required string input identifying which priority resource to fetch from OpenProject.

Output

The output is a JSON object representing the retrieved priority resource from OpenProject. It contains all fields returned by the OpenProject API for a priority, such as its ID, name, and any other metadata defined by the API.

No binary data is output by this node.

Example output structure (simplified):

{
  "id": "123",
  "name": "High",
  "color": "#FF0000",
  "position": 1,
  // ... other priority-specific fields
}

Dependencies

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

Troubleshooting

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

  • Error: "OpenProject error response: ..."
    This means the API returned an error message. Common causes include:

    • Invalid or missing Priority ID.
    • Incorrect API key or insufficient permissions.
    • Network connectivity issues.
  • Error: "The method 'GET' is not supported!"
    This would indicate an internal issue; verify the operation is set to "Get" and resource to "Priority".

  • If the node fails but "Continue On Fail" is enabled, errors will be returned in the output JSON under an error field.

Links and References

Discussion