OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation allows you to list work package schemas from OpenProject by applying specific filter conditions. Work package schemas define the structure and fields of work packages within projects, which are essential for project management tasks such as issue tracking, task assignment, and progress monitoring.

Common scenarios where this node is beneficial include:

  • Retrieving schema details to dynamically generate forms or UI elements based on the schema.
  • Filtering schemas by project and work package type to customize workflows.
  • Integrating with other systems that require knowledge of work package structures.

For example, you might use this node to fetch schemas for work packages belonging to certain projects and types, then use that information to validate or enrich data before creating or updating work packages.

Properties

Name Meaning
Filters JSON string specifying filter conditions to select which work package schemas to list. It accepts the same format as returned by the OpenProject queries endpoint. Currently supported filters include: id, which is the schema's identifier in the form project_id-work_package_type_id. Example: [{"id": {"operator": "=", "values": ["12-1", "14-2"]}}]

Output

The node outputs a JSON array containing the filtered list of work package schemas. Each item in the output corresponds to a schema matching the specified filters and includes details such as schema ID, associated project, work package type, and field definitions.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node depends on the OpenProject REST API being accessible at the URL provided in the credentials.
  • No additional external services or environment variables are required beyond the API authentication setup.

Troubleshooting

  • Invalid Filter Format: If the filter JSON is malformed or does not conform to the expected query format, the API may return an error. Ensure the filter string is valid JSON and matches the documented filter structure.
  • Authentication Errors: Failure to provide valid API credentials will result in authorization errors. Verify that the API key and base URL are correctly configured.
  • Empty Results: If no schemas match the filter criteria, the output will be an empty array. Double-check the filter values, especially the schema IDs.
  • API Endpoint Issues: Network issues or incorrect base URLs can cause request failures. Confirm connectivity and correct API endpoint configuration.

Links and References

Discussion