OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the OpenProject API to retrieve the schema of a specific Work Package. It is useful when you need to understand the structure, fields, and metadata of a particular Work Package type within OpenProject. For example, it can help dynamically generate forms or validate data before creating or updating work packages by providing detailed schema information.

Properties

Name Meaning
Identifier Identifier of the schema to view (e.g., "12-13")

Output

The node outputs JSON data representing the schema of the specified Work Package. This JSON includes details about the fields, their types, constraints, and other metadata that define how the Work Package is structured in OpenProject. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • Depends on the OpenProject REST API being accessible and responsive.

Troubleshooting

  • Invalid Identifier: If the provided identifier does not correspond to any existing schema, the node may return an error or empty response. Verify the identifier value.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access Work Package schemas.
  • Network Issues: Connectivity problems to the OpenProject server will cause failures; check network settings and URL correctness.
  • API Changes: If OpenProject updates its API, the node might fail; ensure compatibility with the current API version.

Links and References

Discussion