OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node integrates with the OpenProject API to retrieve all priority resources. It allows users to fetch a list of priorities with various options such as limiting the number of results, filtering by specific fields, sorting, selecting particular fields, and grouping the results.

Common scenarios where this node is beneficial include:

  • Retrieving all priority levels defined in an OpenProject instance to display or use them in workflows.
  • Filtering priorities based on status or other attributes for reporting or automation.
  • Sorting and grouping priorities to organize data for dashboards or further processing.

Practical example:

  • A project management workflow that needs to fetch all priority levels to assign appropriate priority tags to tasks automatically.

Properties

Name Meaning
Limit Max number of results to return (minimum 1).
Offset Number of results to skip (minimum 0).
Filter Filter results by specific fields using a key=value format, e.g., status=open.
Sort By Sort results by field and direction, e.g., created_at:desc.
Select Fields Comma-separated list of fields to include in the response, e.g., id,name,status.
Group By Group results by a specific field, e.g., status.

Output

The output is an array of JSON objects representing the retrieved priority resources from OpenProject. Each object contains the fields returned by the API according to the selected options (fields, filters, etc.).

The node does not output binary data.

Example output structure (simplified):

[
  {
    "json": {
      "id": "1",
      "name": "High",
      "status": "active",
      ...
    }
  },
  {
    "json": {
      "id": "2",
      "name": "Low",
      "status": "active",
      ...
    }
  }
]

Dependencies

  • Requires an active OpenProject API connection with a valid base URL and API key credential.
  • The node uses HTTP Basic Authentication with the API key encoded in Base64.
  • No additional external dependencies beyond the OpenProject API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Incorrect filter syntax may result in no data or API errors.
    • Requesting unsupported fields in Select Fields can lead to empty or partial responses.
    • Exceeding API rate limits or server errors from OpenProject.

  • Error messages:

    • Errors returned by the OpenProject API are surfaced with their message, e.g., OpenProject error response: <message>.
    • Network or unexpected errors show the raw error message.

  • Resolutions:

    • Verify API key and base URL configuration.
    • Ensure filter strings follow the key=value format.
    • Use valid field names for sorting, selecting, and grouping.
    • Handle pagination properly using Limit and Offset.

Links and References

Discussion