OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation creates a relation between work packages in an OpenProject system. It is useful for project management scenarios where tasks or work items need to be linked to show dependencies, duplicates, or other relationships. For example, you can use it to mark that one task blocks another, or that two tasks are duplicates of each other.

Practical examples:

  • Linking a bug report as a duplicate of an existing issue.
  • Defining that one task must be completed before another can start (precedes).
  • Indicating that one work package blocks the progress of another.

Properties

Name Meaning
Id The ID of the work package to which the relation will be added.
Type The type of relation between work packages. Options: Relates, Duplicates, Duplicated, Blocks, Blocked, Precedes, Follows, Includes, Partof, Requires, Required.
Description A descriptive text explaining the nature of the relation.
Lag The lag time in days between closing the "from" work package and starting the "to" work package.
Links JSON object defining the target work package link, including API endpoint and HTTP method.

Output

The node outputs JSON data representing the created relation object as returned by the OpenProject API. This typically includes details such as the relation's ID, type, description, lag, and links to the related work packages.

No binary data output is involved.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing work package IDs can cause errors.
    • Incorrect relation types or malformed JSON in the Links property may lead to request failures.
    • Authentication errors if API credentials are incorrect or missing.
    • Network connectivity problems to the OpenProject server.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API key credential is correctly set up and has sufficient permissions.
    • 404 Not Found: Verify that the work package IDs exist in the OpenProject instance.
    • 400 Bad Request: Ensure all required properties are provided and JSON fields like Links are correctly formatted.
    • 500 Internal Server Error: May indicate server-side issues; retry later or contact OpenProject support.

Links and References

Discussion