OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation updates an existing relation between work packages in OpenProject. Relations define how two work packages are connected, such as one blocking another or one preceding another. This operation is useful for project managers or automation workflows that need to modify the nature of dependencies or relationships between tasks dynamically.

Practical examples:

  • Changing a relation type from "blocks" to "duplicates" when a task is found to be a duplicate rather than a blocker.
  • Adding a lag time between related tasks to reflect delays or buffer periods.
  • Updating descriptive text to clarify the nature of the relationship between two work packages.

Properties

Name Meaning
Id The unique identifier of the relation to update (Relation ID).
Type The type of relation between work packages. Options: Relates, Duplicates, Duplicated, Blocks, Blocked, Precedes, Follows, Includes, Partof, Requires, Required.
Description A descriptive text providing additional details about the relation.
Lag The lag time in days between the closing of the "from" work package and the start of the "to" work package.
Links JSON object defining the target work package(s) linked by this relation. Typically includes the API endpoint and HTTP method for the linked resource.

Output

The node outputs JSON data representing the updated relation object as returned by the OpenProject API. This typically includes all properties of the relation such as its id, type, description, lag, and links to 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.
  • The node uses the OpenProject REST API to perform the update operation on relations.

Troubleshooting

  • Invalid Relation ID: If the provided relation ID does not exist, the API will return an error. Verify the ID before updating.
  • Unauthorized Access: Missing or invalid API credentials will cause authentication errors. Ensure the API key and URL are correctly set.
  • Invalid Relation Type: Providing a relation type outside the allowed options will result in validation errors.
  • Malformed Links JSON: The _links property must be valid JSON; otherwise, parsing errors will occur. Use proper JSON formatting.
  • Lag Value Issues: Lag should be a number representing days; non-numeric values may cause errors.

Links and References

Discussion